From 925ce2e0e16e9ae4b2e7bc17a82d1a2fd3bd1c4a Mon Sep 17 00:00:00 2001 From: gaubansa Date: Mon, 22 Jul 2024 23:01:18 +0530 Subject: [PATCH 1/2] july spec changes --- CyberSource/__init__.py | 56 +- CyberSource/api/__init__.py | 1 + CyberSource/api/bin_lookup_api.py | 161 ++ CyberSource/api/create_new_webhooks_api.py | 12 +- CyberSource/api/manage_webhooks_api.py | 6 +- CyberSource/api/merchant_boarding_api.py | 6 +- .../unified_checkout_capture_context_api.py | 4 +- CyberSource/models/__init__.py | 55 +- ...response.py => bin_lookupv400_response.py} | 38 +- ...1binlookup_client_reference_information.py | 206 ++ .../binv1binlookup_payment_information.py | 200 ++ ...binv1binlookup_payment_information_card.py | 124 ++ .../binv1binlookup_processing_information.py | 150 ++ ...p_processing_information_payout_options.py | 180 ++ .../binv1binlookup_token_information.py | 152 ++ .../models/create_bin_lookup_request.py | 200 ++ CyberSource/models/inline_response2002.py | 6 +- CyberSource/models/inline_response2011.py | 198 +- .../inline_response2011_issuer_information.py | 236 +++ ...esponse2011_payment_account_information.py | 174 ++ ...se2011_payment_account_information_card.py | 264 +++ ...payment_account_information_card_brands.py | 152 ++ ...11_payment_account_information_features.py | 348 ++++ ...011_payment_account_information_network.py | 124 ++ .../inline_response2011_payout_information.py | 176 ++ ...ponse2011_payout_information_pull_funds.py | 152 ++ ...ponse2011_payout_information_push_funds.py | 488 +++++ CyberSource/models/inline_response2012.py | 218 ++- ...e_response2012_integration_information.py} | 20 +- ...tion_information_tenant_configurations.py} | 38 +- ..._response2012_organization_information.py} | 30 +- ...esponse2012_product_information_setups.py} | 28 +- ..._response2012_registration_information.py} | 30 +- ...etups.py => inline_response2012_setups.py} | 62 +- ...response2012_setups_commerce_solutions.py} | 48 +- ...=> inline_response2012_setups_payments.py} | 244 +-- ...se2012_setups_payments_card_processing.py} | 34 +- ...s_card_processing_configuration_status.py} | 62 +- ...ts_card_processing_subscription_status.py} | 46 +- ...e2012_setups_payments_digital_payments.py} | 20 +- ....py => inline_response2012_setups_risk.py} | 34 +- ...sponse2012_setups_value_added_services.py} | 34 +- CyberSource/models/inline_response2013.py | 410 +--- ...=> inline_response2013_key_information.py} | 100 +- ...2013_key_information_error_information.py} | 28 +- ..._information_error_information_details.py} | 22 +- CyberSource/models/inline_response2014.py | 410 +++- CyberSource/models/inline_response2015.py | 204 ++ ...rder_information_amount_details_freight.py | 4 +- ..._information_amount_details_tax_details.py | 8 +- ...v2invoices_order_information_line_items.py | 8 +- .../merchant_initiated_transaction_object.py | 8 +- ...patch201_response_processor_information.py | 4 +- ..._post201_response_processor_information.py | 4 +- ...post201_response1_processor_information.py | 4 +- ...post201_response2_processor_information.py | 4 +- ...nse_consumer_authentication_information.py | 4 +- ...ost201_response_installment_information.py | 92 +- ...nts_post201_response_issuer_information.py | 16 +- ...onse_payment_information_tokenized_card.py | 16 +- ...1_response_payment_insights_information.py | 32 +- ...ment_insights_information_orchestration.py | 124 ++ ..._insights_information_response_insights.py | 8 +- ...t201_response_point_of_sale_information.py | 4 +- ...post201_response_processing_information.py | 4 +- ..._post201_response_processor_information.py | 4 +- ...e_processor_information_merchant_advice.py | 8 +- ...als_post201_response_issuer_information.py | 4 +- ...ushfundstransfer_processing_information.py | 34 +- ...tsv2billingagreements_buyer_information.py | 4 +- ...llingagreements_installment_information.py | 12 +- ...2billingagreements_merchant_information.py | 4 +- ...erchant_information_merchant_descriptor.py | 4 +- ...ents_payment_information_tokenized_card.py | 8 +- .../ptsv2credits_installment_information.py | 4 +- .../ptsv2credits_processing_information.py | 4 +- ...references_order_information_line_items.py | 12 +- ...entreferences_order_information_ship_to.py | 4 +- ...nts_aggregator_information_sub_merchant.py | 24 +- ...nts_consumer_authentication_information.py | 8 +- .../ptsv2payments_installment_information.py | 40 +- .../ptsv2payments_issuer_information.py | 4 +- .../ptsv2payments_merchant_information.py | 20 +- ...erchant_information_merchant_descriptor.py | 12 +- ...yments_order_information_amount_details.py | 34 +- ..._order_information_amount_details_order.py | 4 +- ..._information_amount_details_tax_details.py | 24 +- ...ments_order_information_invoice_details.py | 28 +- ...v2payments_order_information_line_items.py | 36 +- ...ptsv2payments_order_information_ship_to.py | 4 +- .../ptsv2payments_payment_information.py | 32 +- ...t_information_payment_account_reference.py | 124 ++ ...ents_payment_information_tokenized_card.py | 12 +- ...ptsv2payments_point_of_sale_information.py | 4 +- .../ptsv2payments_processing_information.py | 66 +- ...nts_processing_information_loan_options.py | 4 +- ...rocessing_information_recurring_options.py | 8 +- .../ptsv2payments_recipient_information.py | 20 +- ...res_aggregator_information_sub_merchant.py | 20 +- ...mentsidcaptures_installment_information.py | 96 +- ...paymentsidcaptures_merchant_information.py | 16 +- ...tures_order_information_invoice_details.py | 24 +- ...ntsidcaptures_point_of_sale_information.py | 4 +- ...ymentsidcaptures_processing_information.py | 4 +- ...2paymentsidrefunds_merchant_information.py | 16 +- ...sidrefunds_order_information_line_items.py | 16 +- ...v2paymentsidrefunds_payment_information.py | 32 +- ...aymentsidrefunds_processing_information.py | 4 +- ...rocessing_information_recurring_options.py | 4 +- ...dreversals_order_information_line_items.py | 4 +- ...mentsidreversals_processing_information.py | 4 +- .../ptsv2payouts_merchant_information.py | 8 +- ...erchant_information_merchant_descriptor.py | 8 +- .../ptsv2payouts_processing_information.py | 8 +- .../ptsv2voids_processing_information.py | 10 +- ...nse_consumer_authentication_information.py | 4 +- ...nse_consumer_authentication_information.py | 4 +- ...ifications_order_information_line_items.py | 8 +- ...ults_payment_information_tokenized_card.py | 8 +- ...ntications_order_information_line_items.py | 8 +- ...ions_payment_information_tokenized_card.py | 12 +- ...tups_payment_information_tokenized_card.py | 8 +- ...enticationsetups_processing_information.py | 4 +- ...isions_order_information_amount_details.py | 4 +- ...1decisions_order_information_line_items.py | 12 +- ...ions_payment_information_tokenized_card.py | 8 +- ...einquiries_order_information_line_items.py | 8 +- ...ypeentries_order_information_line_items.py | 4 +- ...dded_instrument_identifier_bank_account.py | 4 +- .../tms_payment_instrument_processing_info.py | 4 +- ...t_processing_info_bank_transfer_options.py | 4 +- ...lt_payment_instrument_buyer_information.py | 4 +- ...0_response_order_information_line_items.py | 8 +- ...t200_response_order_information_ship_to.py | 4 +- ...rmation_authorization_options_initiator.py | 4 +- ...s_get200_response_processor_information.py | 4 +- ...esponse_embedded_processing_information.py | 4 +- ..._risk_information_providers_fingerprint.py | 4 +- .../models/vasv2tax_merchant_information.py | 4 +- .../vasv2tax_order_information_line_items.py | 12 +- docs/BinLookupApi.md | 57 + ...00Response.md => BinLookupv400Response.md} | 2 +- ...inv1binlookupClientReferenceInformation.md | 13 + docs/Binv1binlookupPaymentInformation.md | 13 + docs/Binv1binlookupPaymentInformationCard.md | 10 + docs/Binv1binlookupProcessingInformation.md | 11 + ...ookupProcessingInformationPayoutOptions.md | 12 + docs/Binv1binlookupTokenInformation.md | 11 + docs/CreateBinLookupRequest.md | 13 + docs/CreateNewWebhooksApi.md | 8 +- docs/InlineResponse2002.md | 2 +- docs/InlineResponse2011.md | 15 +- docs/InlineResponse2011IssuerInformation.md | 14 + ...neResponse2011PaymentAccountInformation.md | 12 + ...sponse2011PaymentAccountInformationCard.md | 15 + ...2011PaymentAccountInformationCardBrands.md | 11 + ...se2011PaymentAccountInformationFeatures.md | 18 + ...nse2011PaymentAccountInformationNetwork.md | 10 + docs/InlineResponse2011PayoutInformation.md | 12 + ...eResponse2011PayoutInformationPullFunds.md | 11 + ...eResponse2011PayoutInformationPushFunds.md | 23 + docs/InlineResponse2011Setups.md | 13 - ...lineResponse2011SetupsCommerceSolutions.md | 12 - docs/InlineResponse2011SetupsPayments.md | 26 - docs/InlineResponse2012.md | 13 +- ...lineResponse2012IntegrationInformation.md} | 4 +- ...grationInformationTenantConfigurations.md} | 2 +- ...ineResponse2012OrganizationInformation.md} | 2 +- ...neResponse2012ProductInformationSetups.md} | 4 +- ...ineResponse2012RegistrationInformation.md} | 2 +- docs/InlineResponse2012Setups.md | 13 + ...lineResponse2012SetupsCommerceSolutions.md | 12 + docs/InlineResponse2012SetupsPayments.md | 26 + ...sponse2012SetupsPaymentsCardProcessing.md} | 6 +- ...mentsCardProcessingConfigurationStatus.md} | 2 +- ...ymentsCardProcessingSubscriptionStatus.md} | 2 +- ...ponse2012SetupsPaymentsDigitalPayments.md} | 4 +- ...isk.md => InlineResponse2012SetupsRisk.md} | 6 +- ...neResponse2012SetupsValueAddedServices.md} | 6 +- docs/InlineResponse2013.md | 19 +- ...md => InlineResponse2013KeyInformation.md} | 4 +- ...onse2013KeyInformationErrorInformation.md} | 4 +- ...3KeyInformationErrorInformationDetails.md} | 2 +- docs/InlineResponse2014.md | 19 +- docs/InlineResponse2015.md | 13 + ...cesOrderInformationAmountDetailsFreight.md | 2 +- ...OrderInformationAmountDetailsTaxDetails.md | 4 +- ...cingv2invoicesOrderInformationLineItems.md | 4 +- docs/ManageWebhooksApi.md | 4 +- docs/MerchantBoardingApi.md | 4 +- docs/MerchantInitiatedTransactionObject.md | 4 +- ...ionPatch201ResponseProcessorInformation.md | 2 +- ...rderPost201ResponseProcessorInformation.md | 2 +- ...ntsPost201Response1ProcessorInformation.md | 2 +- ...ntsPost201Response2ProcessorInformation.md | 2 +- ...sponseConsumerAuthenticationInformation.md | 2 +- ...tsPost201ResponseInstallmentInformation.md | 46 +- ...aymentsPost201ResponseIssuerInformation.md | 8 +- ...ResponsePaymentInformationTokenizedCard.md | 8 +- ...st201ResponsePaymentInsightsInformation.md | 1 + ...PaymentInsightsInformationOrchestration.md | 10 + ...mentInsightsInformationResponseInsights.md | 4 +- ...tsPost201ResponsePointOfSaleInformation.md | 2 +- ...ntsPost201ResponseProcessingInformation.md | 2 +- ...entsPost201ResponseProcessorInformation.md | 2 +- ...ponseProcessorInformationMerchantAdvice.md | 4 +- ...versalsPost201ResponseIssuerInformation.md | 2 +- ...1pushfundstransferProcessingInformation.md | 1 + .../Ptsv2billingagreementsBuyerInformation.md | 2 +- ...billingagreementsInstallmentInformation.md | 6 +- ...sv2billingagreementsMerchantInformation.md | 2 +- ...tsMerchantInformationMerchantDescriptor.md | 2 +- ...reementsPaymentInformationTokenizedCard.md | 4 +- docs/Ptsv2creditsInstallmentInformation.md | 2 +- docs/Ptsv2creditsProcessingInformation.md | 2 +- ...mentreferencesOrderInformationLineItems.md | 6 +- ...paymentreferencesOrderInformationShipTo.md | 2 +- ...aymentsAggregatorInformationSubMerchant.md | 12 +- ...ymentsConsumerAuthenticationInformation.md | 4 +- docs/Ptsv2paymentsInstallmentInformation.md | 20 +- docs/Ptsv2paymentsIssuerInformation.md | 2 +- docs/Ptsv2paymentsMerchantInformation.md | 10 +- ...tsMerchantInformationMerchantDescriptor.md | 6 +- ...v2paymentsOrderInformationAmountDetails.md | 1 + ...mentsOrderInformationAmountDetailsOrder.md | 2 +- ...OrderInformationAmountDetailsTaxDetails.md | 12 +- ...2paymentsOrderInformationInvoiceDetails.md | 14 +- .../Ptsv2paymentsOrderInformationLineItems.md | 18 +- docs/Ptsv2paymentsOrderInformationShipTo.md | 2 +- docs/Ptsv2paymentsPaymentInformation.md | 1 + ...ymentInformationPaymentAccountReference.md | 10 + ...paymentsPaymentInformationTokenizedCard.md | 6 +- docs/Ptsv2paymentsPointOfSaleInformation.md | 2 +- docs/Ptsv2paymentsProcessingInformation.md | 4 +- ...aymentsProcessingInformationLoanOptions.md | 2 +- ...tsProcessingInformationRecurringOptions.md | 4 +- docs/Ptsv2paymentsRecipientInformation.md | 10 +- ...apturesAggregatorInformationSubMerchant.md | 10 +- ...aymentsidcapturesInstallmentInformation.md | 48 +- ...v2paymentsidcapturesMerchantInformation.md | 8 +- ...dcapturesOrderInformationInvoiceDetails.md | 12 +- ...aymentsidcapturesPointOfSaleInformation.md | 2 +- ...paymentsidcapturesProcessingInformation.md | 2 +- ...sv2paymentsidrefundsMerchantInformation.md | 8 +- ...mentsidrefundsOrderInformationLineItems.md | 8 +- ...tsv2paymentsidrefundsPaymentInformation.md | 1 + ...2paymentsidrefundsProcessingInformation.md | 2 +- ...dsProcessingInformationRecurringOptions.md | 2 +- ...ntsidreversalsOrderInformationLineItems.md | 2 +- ...aymentsidreversalsProcessingInformation.md | 2 +- docs/Ptsv2payoutsMerchantInformation.md | 4 +- ...tsMerchantInformationMerchantDescriptor.md | 4 +- docs/Ptsv2payoutsProcessingInformation.md | 4 +- docs/Ptsv2voidsProcessingInformation.md | 2 +- ...sponseConsumerAuthenticationInformation.md | 2 +- ...sponseConsumerAuthenticationInformation.md | 2 +- ...sverificationsOrderInformationLineItems.md | 4 +- ...nresultsPaymentInformationTokenizedCard.md | 4 +- ...uthenticationsOrderInformationLineItems.md | 4 +- ...icationsPaymentInformationTokenizedCard.md | 6 +- ...onsetupsPaymentInformationTokenizedCard.md | 4 +- ...thenticationsetupsProcessingInformation.md | 2 +- ...1decisionsOrderInformationAmountDetails.md | 2 +- ...iskv1decisionsOrderInformationLineItems.md | 6 +- ...ecisionsPaymentInformationTokenizedCard.md | 4 +- ...ianceinquiriesOrderInformationLineItems.md | 4 +- ...ststypeentriesOrderInformationLineItems.md | 2 +- ...EmbeddedInstrumentIdentifierBankAccount.md | 2 +- docs/TmsPaymentInstrumentProcessingInfo.md | 2 +- ...rumentProcessingInfoBankTransferOptions.md | 2 +- ...efaultPaymentInstrumentBuyerInformation.md | 2 +- ...Get200ResponseOrderInformationLineItems.md | 4 +- ...onsGet200ResponseOrderInformationShipTo.md | 2 +- ...nformationAuthorizationOptionsInitiator.md | 2 +- ...tionsGet200ResponseProcessorInformation.md | 2 +- ...01ResponseEmbeddedProcessingInformation.md | 2 +- ...ddedRiskInformationProvidersFingerprint.md | 2 +- docs/UnifiedCheckoutCaptureContextApi.md | 2 +- docs/Vasv2taxMerchantInformation.md | 2 +- docs/Vasv2taxOrderInformationLineItems.md | 6 +- generator/cybersource-rest-spec.json | 1712 +++++++++++------ test/test_bin_lookup_api.py | 43 + ...ups.py => test_bin_lookupv400_response.py} | 12 +- ...binlookup_client_reference_information.py} | 12 +- ...est_binv1binlookup_payment_information.py} | 12 +- ...binv1binlookup_payment_information_card.py | 43 + ...t_binv1binlookup_processing_information.py | 43 + ...p_processing_information_payout_options.py | 43 + ... test_binv1binlookup_token_information.py} | 12 +- ...k.py => test_create_bin_lookup_request.py} | 12 +- ..._inline_response2011_issuer_information.py | 43 + ...esponse2011_payment_account_information.py | 43 + ...se2011_payment_account_information_card.py | 43 + ...payment_account_information_card_brands.py | 43 + ...11_payment_account_information_features.py | 43 + ...011_payment_account_information_network.py | 43 + ..._inline_response2011_payout_information.py | 43 + ...ponse2011_payout_information_pull_funds.py | 43 + ...ponse2011_payout_information_push_funds.py | 43 + ...ne_response2012_integration_information.py | 43 + ...tion_information_tenant_configurations.py} | 12 +- ..._response2012_organization_information.py} | 12 +- ...esponse2012_product_information_setups.py} | 12 +- ..._response2012_registration_information.py} | 12 +- test/test_inline_response2012_setups.py | 43 + ...response2012_setups_commerce_solutions.py} | 12 +- ...est_inline_response2012_setups_payments.py | 43 + ...se2012_setups_payments_card_processing.py} | 12 +- ...s_card_processing_configuration_status.py} | 12 +- ...ts_card_processing_subscription_status.py} | 12 +- ...e2012_setups_payments_digital_payments.py} | 12 +- test/test_inline_response2012_setups_risk.py | 43 + ...sponse2012_setups_value_added_services.py} | 12 +- ...est_inline_response2013_key_information.py | 43 + ...2013_key_information_error_information.py} | 12 +- ..._information_error_information_details.py} | 12 +- test/test_inline_response2015.py | 43 + ...ment_insights_information_orchestration.py | 43 + ...t_information_payment_account_reference.py | 43 + ...st_tss_v2_transactions_post400_response.py | 43 - 320 files changed, 8604 insertions(+), 2637 deletions(-) create mode 100644 CyberSource/api/bin_lookup_api.py rename CyberSource/models/{tss_v2_transactions_post400_response.py => bin_lookupv400_response.py} (78%) create mode 100644 CyberSource/models/binv1binlookup_client_reference_information.py create mode 100644 CyberSource/models/binv1binlookup_payment_information.py create mode 100644 CyberSource/models/binv1binlookup_payment_information_card.py create mode 100644 CyberSource/models/binv1binlookup_processing_information.py create mode 100644 CyberSource/models/binv1binlookup_processing_information_payout_options.py create mode 100644 CyberSource/models/binv1binlookup_token_information.py create mode 100644 CyberSource/models/create_bin_lookup_request.py create mode 100644 CyberSource/models/inline_response2011_issuer_information.py create mode 100644 CyberSource/models/inline_response2011_payment_account_information.py create mode 100644 CyberSource/models/inline_response2011_payment_account_information_card.py create mode 100644 CyberSource/models/inline_response2011_payment_account_information_card_brands.py create mode 100644 CyberSource/models/inline_response2011_payment_account_information_features.py create mode 100644 CyberSource/models/inline_response2011_payment_account_information_network.py create mode 100644 CyberSource/models/inline_response2011_payout_information.py create mode 100644 CyberSource/models/inline_response2011_payout_information_pull_funds.py create mode 100644 CyberSource/models/inline_response2011_payout_information_push_funds.py rename CyberSource/models/{inline_response2011_integration_information.py => inline_response2012_integration_information.py} (87%) rename CyberSource/models/{inline_response2011_integration_information_tenant_configurations.py => inline_response2012_integration_information_tenant_configurations.py} (84%) rename CyberSource/models/{inline_response2011_organization_information.py => inline_response2012_organization_information.py} (85%) rename CyberSource/models/{inline_response2011_product_information_setups.py => inline_response2012_product_information_setups.py} (80%) rename CyberSource/models/{inline_response2011_registration_information.py => inline_response2012_registration_information.py} (83%) rename CyberSource/models/{inline_response2011_setups.py => inline_response2012_setups.py} (72%) rename CyberSource/models/{inline_response2011_setups_commerce_solutions.py => inline_response2012_setups_commerce_solutions.py} (73%) rename CyberSource/models/{inline_response2011_setups_payments.py => inline_response2012_setups_payments.py} (64%) rename CyberSource/models/{inline_response2011_setups_payments_card_processing.py => inline_response2012_setups_payments_card_processing.py} (79%) rename CyberSource/models/{inline_response2011_setups_payments_card_processing_configuration_status.py => inline_response2012_setups_payments_card_processing_configuration_status.py} (79%) rename CyberSource/models/{inline_response2011_setups_payments_card_processing_subscription_status.py => inline_response2012_setups_payments_card_processing_subscription_status.py} (81%) rename CyberSource/models/{inline_response2011_setups_payments_digital_payments.py => inline_response2012_setups_payments_digital_payments.py} (83%) rename CyberSource/models/{inline_response2011_setups_risk.py => inline_response2012_setups_risk.py} (80%) rename CyberSource/models/{inline_response2011_setups_value_added_services.py => inline_response2012_setups_value_added_services.py} (77%) rename CyberSource/models/{inline_response2012_key_information.py => inline_response2013_key_information.py} (74%) rename CyberSource/models/{inline_response2012_key_information_error_information.py => inline_response2013_key_information_error_information.py} (79%) rename CyberSource/models/{inline_response2012_key_information_error_information_details.py => inline_response2013_key_information_error_information_details.py} (83%) create mode 100644 CyberSource/models/inline_response2015.py create mode 100644 CyberSource/models/pts_v2_payments_post201_response_payment_insights_information_orchestration.py create mode 100644 CyberSource/models/ptsv2payments_payment_information_payment_account_reference.py create mode 100644 docs/BinLookupApi.md rename docs/{TssV2TransactionsPost400Response.md => BinLookupv400Response.md} (96%) create mode 100644 docs/Binv1binlookupClientReferenceInformation.md create mode 100644 docs/Binv1binlookupPaymentInformation.md create mode 100644 docs/Binv1binlookupPaymentInformationCard.md create mode 100644 docs/Binv1binlookupProcessingInformation.md create mode 100644 docs/Binv1binlookupProcessingInformationPayoutOptions.md create mode 100644 docs/Binv1binlookupTokenInformation.md create mode 100644 docs/CreateBinLookupRequest.md create mode 100644 docs/InlineResponse2011IssuerInformation.md create mode 100644 docs/InlineResponse2011PaymentAccountInformation.md create mode 100644 docs/InlineResponse2011PaymentAccountInformationCard.md create mode 100644 docs/InlineResponse2011PaymentAccountInformationCardBrands.md create mode 100644 docs/InlineResponse2011PaymentAccountInformationFeatures.md create mode 100644 docs/InlineResponse2011PaymentAccountInformationNetwork.md create mode 100644 docs/InlineResponse2011PayoutInformation.md create mode 100644 docs/InlineResponse2011PayoutInformationPullFunds.md create mode 100644 docs/InlineResponse2011PayoutInformationPushFunds.md delete mode 100644 docs/InlineResponse2011Setups.md delete mode 100644 docs/InlineResponse2011SetupsCommerceSolutions.md delete mode 100644 docs/InlineResponse2011SetupsPayments.md rename docs/{InlineResponse2011IntegrationInformation.md => InlineResponse2012IntegrationInformation.md} (72%) rename docs/{InlineResponse2011IntegrationInformationTenantConfigurations.md => InlineResponse2012IntegrationInformationTenantConfigurations.md} (93%) rename docs/{InlineResponse2011OrganizationInformation.md => InlineResponse2012OrganizationInformation.md} (90%) rename docs/{InlineResponse2011ProductInformationSetups.md => InlineResponse2012ProductInformationSetups.md} (76%) rename docs/{InlineResponse2011RegistrationInformation.md => InlineResponse2012RegistrationInformation.md} (92%) create mode 100644 docs/InlineResponse2012Setups.md create mode 100644 docs/InlineResponse2012SetupsCommerceSolutions.md create mode 100644 docs/InlineResponse2012SetupsPayments.md rename docs/{InlineResponse2011SetupsPaymentsCardProcessing.md => InlineResponse2012SetupsPaymentsCardProcessing.md} (55%) rename docs/{InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus.md => InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus.md} (92%) rename docs/{InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus.md => InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus.md} (91%) rename docs/{InlineResponse2011SetupsPaymentsDigitalPayments.md => InlineResponse2012SetupsPaymentsDigitalPayments.md} (64%) rename docs/{InlineResponse2011SetupsRisk.md => InlineResponse2012SetupsRisk.md} (52%) rename docs/{InlineResponse2011SetupsValueAddedServices.md => InlineResponse2012SetupsValueAddedServices.md} (50%) rename docs/{InlineResponse2012KeyInformation.md => InlineResponse2013KeyInformation.md} (86%) rename docs/{InlineResponse2012KeyInformationErrorInformation.md => InlineResponse2013KeyInformationErrorInformation.md} (70%) rename docs/{InlineResponse2012KeyInformationErrorInformationDetails.md => InlineResponse2013KeyInformationErrorInformationDetails.md} (89%) create mode 100644 docs/InlineResponse2015.md create mode 100644 docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration.md create mode 100644 docs/Ptsv2paymentsPaymentInformationPaymentAccountReference.md create mode 100644 test/test_bin_lookup_api.py rename test/{test_inline_response2011_setups.py => test_bin_lookupv400_response.py} (65%) rename test/{test_inline_response2011_integration_information.py => test_binv1binlookup_client_reference_information.py} (58%) rename test/{test_inline_response2012_key_information.py => test_binv1binlookup_payment_information.py} (61%) create mode 100644 test/test_binv1binlookup_payment_information_card.py create mode 100644 test/test_binv1binlookup_processing_information.py create mode 100644 test/test_binv1binlookup_processing_information_payout_options.py rename test/{test_inline_response2011_setups_payments.py => test_binv1binlookup_token_information.py} (61%) rename test/{test_inline_response2011_setups_risk.py => test_create_bin_lookup_request.py} (63%) create mode 100644 test/test_inline_response2011_issuer_information.py create mode 100644 test/test_inline_response2011_payment_account_information.py create mode 100644 test/test_inline_response2011_payment_account_information_card.py create mode 100644 test/test_inline_response2011_payment_account_information_card_brands.py create mode 100644 test/test_inline_response2011_payment_account_information_features.py create mode 100644 test/test_inline_response2011_payment_account_information_network.py create mode 100644 test/test_inline_response2011_payout_information.py create mode 100644 test/test_inline_response2011_payout_information_pull_funds.py create mode 100644 test/test_inline_response2011_payout_information_push_funds.py create mode 100644 test/test_inline_response2012_integration_information.py rename test/{test_inline_response2011_integration_information_tenant_configurations.py => test_inline_response2012_integration_information_tenant_configurations.py} (61%) rename test/{test_inline_response2011_registration_information.py => test_inline_response2012_organization_information.py} (58%) rename test/{test_inline_response2011_product_information_setups.py => test_inline_response2012_product_information_setups.py} (58%) rename test/{test_inline_response2011_organization_information.py => test_inline_response2012_registration_information.py} (58%) create mode 100644 test/test_inline_response2012_setups.py rename test/{test_inline_response2011_setups_commerce_solutions.py => test_inline_response2012_setups_commerce_solutions.py} (58%) create mode 100644 test/test_inline_response2012_setups_payments.py rename test/{test_inline_response2011_setups_payments_card_processing.py => test_inline_response2012_setups_payments_card_processing.py} (58%) rename test/{test_inline_response2011_setups_payments_card_processing_configuration_status.py => test_inline_response2012_setups_payments_card_processing_configuration_status.py} (62%) rename test/{test_inline_response2011_setups_payments_card_processing_subscription_status.py => test_inline_response2012_setups_payments_card_processing_subscription_status.py} (62%) rename test/{test_inline_response2011_setups_payments_digital_payments.py => test_inline_response2012_setups_payments_digital_payments.py} (58%) create mode 100644 test/test_inline_response2012_setups_risk.py rename test/{test_inline_response2011_setups_value_added_services.py => test_inline_response2012_setups_value_added_services.py} (58%) create mode 100644 test/test_inline_response2013_key_information.py rename test/{test_inline_response2012_key_information_error_information.py => test_inline_response2013_key_information_error_information.py} (58%) rename test/{test_inline_response2012_key_information_error_information_details.py => test_inline_response2013_key_information_error_information_details.py} (60%) create mode 100644 test/test_inline_response2015.py create mode 100644 test/test_pts_v2_payments_post201_response_payment_insights_information_orchestration.py create mode 100644 test/test_ptsv2payments_payment_information_payment_account_reference.py delete mode 100644 test/test_tss_v2_transactions_post400_response.py diff --git a/CyberSource/__init__.py b/CyberSource/__init__.py index 82dc2153..0c99158b 100644 --- a/CyberSource/__init__.py +++ b/CyberSource/__init__.py @@ -25,6 +25,13 @@ from .models.activate_subscription_response_subscription_information import ActivateSubscriptionResponseSubscriptionInformation from .models.add_negative_list_request import AddNegativeListRequest from .models.auth_reversal_request import AuthReversalRequest +from .models.bin_lookupv400_response import BinLookupv400Response +from .models.binv1binlookup_client_reference_information import Binv1binlookupClientReferenceInformation +from .models.binv1binlookup_payment_information import Binv1binlookupPaymentInformation +from .models.binv1binlookup_payment_information_card import Binv1binlookupPaymentInformationCard +from .models.binv1binlookup_processing_information import Binv1binlookupProcessingInformation +from .models.binv1binlookup_processing_information_payout_options import Binv1binlookupProcessingInformationPayoutOptions +from .models.binv1binlookup_token_information import Binv1binlookupTokenInformation from .models.boardingv1registrations_document_information import Boardingv1registrationsDocumentInformation from .models.boardingv1registrations_document_information_signed_documents import Boardingv1registrationsDocumentInformationSignedDocuments from .models.boardingv1registrations_integration_information import Boardingv1registrationsIntegrationInformation @@ -79,6 +86,7 @@ from .models.commerce_solutions_products_token_management_configuration_information_configurations import CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations from .models.create_adhoc_report_request import CreateAdhocReportRequest from .models.create_billing_agreement import CreateBillingAgreement +from .models.create_bin_lookup_request import CreateBinLookupRequest from .models.create_bundled_decision_manager_case_request import CreateBundledDecisionManagerCaseRequest from .models.create_credit_request import CreateCreditRequest from .models.create_invoice_request import CreateInvoiceRequest @@ -190,26 +198,36 @@ from .models.inline_response200_embedded_reversal_links_self import InlineResponse200EmbeddedReversalLinksSelf from .models.inline_response201 import InlineResponse201 from .models.inline_response2011 import InlineResponse2011 -from .models.inline_response2011_integration_information import InlineResponse2011IntegrationInformation -from .models.inline_response2011_integration_information_tenant_configurations import InlineResponse2011IntegrationInformationTenantConfigurations -from .models.inline_response2011_organization_information import InlineResponse2011OrganizationInformation -from .models.inline_response2011_product_information_setups import InlineResponse2011ProductInformationSetups -from .models.inline_response2011_registration_information import InlineResponse2011RegistrationInformation -from .models.inline_response2011_setups import InlineResponse2011Setups -from .models.inline_response2011_setups_commerce_solutions import InlineResponse2011SetupsCommerceSolutions -from .models.inline_response2011_setups_payments import InlineResponse2011SetupsPayments -from .models.inline_response2011_setups_payments_card_processing import InlineResponse2011SetupsPaymentsCardProcessing -from .models.inline_response2011_setups_payments_card_processing_configuration_status import InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus -from .models.inline_response2011_setups_payments_card_processing_subscription_status import InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus -from .models.inline_response2011_setups_payments_digital_payments import InlineResponse2011SetupsPaymentsDigitalPayments -from .models.inline_response2011_setups_risk import InlineResponse2011SetupsRisk -from .models.inline_response2011_setups_value_added_services import InlineResponse2011SetupsValueAddedServices +from .models.inline_response2011_issuer_information import InlineResponse2011IssuerInformation +from .models.inline_response2011_payment_account_information import InlineResponse2011PaymentAccountInformation +from .models.inline_response2011_payment_account_information_card import InlineResponse2011PaymentAccountInformationCard +from .models.inline_response2011_payment_account_information_card_brands import InlineResponse2011PaymentAccountInformationCardBrands +from .models.inline_response2011_payment_account_information_features import InlineResponse2011PaymentAccountInformationFeatures +from .models.inline_response2011_payment_account_information_network import InlineResponse2011PaymentAccountInformationNetwork +from .models.inline_response2011_payout_information import InlineResponse2011PayoutInformation +from .models.inline_response2011_payout_information_pull_funds import InlineResponse2011PayoutInformationPullFunds +from .models.inline_response2011_payout_information_push_funds import InlineResponse2011PayoutInformationPushFunds from .models.inline_response2012 import InlineResponse2012 -from .models.inline_response2012_key_information import InlineResponse2012KeyInformation -from .models.inline_response2012_key_information_error_information import InlineResponse2012KeyInformationErrorInformation -from .models.inline_response2012_key_information_error_information_details import InlineResponse2012KeyInformationErrorInformationDetails +from .models.inline_response2012_integration_information import InlineResponse2012IntegrationInformation +from .models.inline_response2012_integration_information_tenant_configurations import InlineResponse2012IntegrationInformationTenantConfigurations +from .models.inline_response2012_organization_information import InlineResponse2012OrganizationInformation +from .models.inline_response2012_product_information_setups import InlineResponse2012ProductInformationSetups +from .models.inline_response2012_registration_information import InlineResponse2012RegistrationInformation +from .models.inline_response2012_setups import InlineResponse2012Setups +from .models.inline_response2012_setups_commerce_solutions import InlineResponse2012SetupsCommerceSolutions +from .models.inline_response2012_setups_payments import InlineResponse2012SetupsPayments +from .models.inline_response2012_setups_payments_card_processing import InlineResponse2012SetupsPaymentsCardProcessing +from .models.inline_response2012_setups_payments_card_processing_configuration_status import InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus +from .models.inline_response2012_setups_payments_card_processing_subscription_status import InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus +from .models.inline_response2012_setups_payments_digital_payments import InlineResponse2012SetupsPaymentsDigitalPayments +from .models.inline_response2012_setups_risk import InlineResponse2012SetupsRisk +from .models.inline_response2012_setups_value_added_services import InlineResponse2012SetupsValueAddedServices from .models.inline_response2013 import InlineResponse2013 +from .models.inline_response2013_key_information import InlineResponse2013KeyInformation +from .models.inline_response2013_key_information_error_information import InlineResponse2013KeyInformationErrorInformation +from .models.inline_response2013_key_information_error_information_details import InlineResponse2013KeyInformationErrorInformationDetails from .models.inline_response2014 import InlineResponse2014 +from .models.inline_response2015 import InlineResponse2015 from .models.inline_response202 import InlineResponse202 from .models.inline_response202_links import InlineResponse202Links from .models.inline_response202_links_status import InlineResponse202LinksStatus @@ -529,6 +547,7 @@ from .models.pts_v2_payments_post201_response_payment_information_instrument_identifier import PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier from .models.pts_v2_payments_post201_response_payment_information_tokenized_card import PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard from .models.pts_v2_payments_post201_response_payment_insights_information import PtsV2PaymentsPost201ResponsePaymentInsightsInformation +from .models.pts_v2_payments_post201_response_payment_insights_information_orchestration import PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration from .models.pts_v2_payments_post201_response_payment_insights_information_response_insights import PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights from .models.pts_v2_payments_post201_response_point_of_sale_information import PtsV2PaymentsPost201ResponsePointOfSaleInformation from .models.pts_v2_payments_post201_response_point_of_sale_information_emv import PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv @@ -724,6 +743,7 @@ from .models.ptsv2payments_payment_information_instrument_identifier import Ptsv2paymentsPaymentInformationInstrumentIdentifier from .models.ptsv2payments_payment_information_legacy_token import Ptsv2paymentsPaymentInformationLegacyToken from .models.ptsv2payments_payment_information_options import Ptsv2paymentsPaymentInformationOptions +from .models.ptsv2payments_payment_information_payment_account_reference import Ptsv2paymentsPaymentInformationPaymentAccountReference from .models.ptsv2payments_payment_information_payment_instrument import Ptsv2paymentsPaymentInformationPaymentInstrument from .models.ptsv2payments_payment_information_payment_type import Ptsv2paymentsPaymentInformationPaymentType from .models.ptsv2payments_payment_information_payment_type_method import Ptsv2paymentsPaymentInformationPaymentTypeMethod @@ -1230,7 +1250,6 @@ from .models.tss_v2_transactions_post201_response_embedded_risk_information_providers import TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders from .models.tss_v2_transactions_post201_response_embedded_risk_information_providers_fingerprint import TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint from .models.tss_v2_transactions_post201_response_embedded_transaction_summaries import TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries -from .models.tss_v2_transactions_post400_response import TssV2TransactionsPost400Response from .models.tssv2transactionsemv_tag_details_emv_details_list import Tssv2transactionsemvTagDetailsEmvDetailsList from .models.ums_v1_users_get200_response import UmsV1UsersGet200Response from .models.ums_v1_users_get200_response_account_information import UmsV1UsersGet200ResponseAccountInformation @@ -1309,6 +1328,7 @@ from .api.o_auth_api import OAuthApi from .api.asymmetric_key_management_api import AsymmetricKeyManagementApi from .api.batches_api import BatchesApi +from .api.bin_lookup_api import BinLookupApi from .api.chargeback_details_api import ChargebackDetailsApi from .api.chargeback_summaries_api import ChargebackSummariesApi from .api.conversion_details_api import ConversionDetailsApi diff --git a/CyberSource/api/__init__.py b/CyberSource/api/__init__.py index 5c90f3c6..eeee3e7a 100644 --- a/CyberSource/api/__init__.py +++ b/CyberSource/api/__init__.py @@ -4,6 +4,7 @@ from .o_auth_api import OAuthApi from .asymmetric_key_management_api import AsymmetricKeyManagementApi from .batches_api import BatchesApi +from .bin_lookup_api import BinLookupApi from .chargeback_details_api import ChargebackDetailsApi from .chargeback_summaries_api import ChargebackSummariesApi from .conversion_details_api import ConversionDetailsApi diff --git a/CyberSource/api/bin_lookup_api.py b/CyberSource/api/bin_lookup_api.py new file mode 100644 index 00000000..cf369962 --- /dev/null +++ b/CyberSource/api/bin_lookup_api.py @@ -0,0 +1,161 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import sys +import os +import re + +# python 2 and python 3 compatibility library +from six import iteritems + +from ..configuration import Configuration +from ..api_client import ApiClient +import CyberSource.logging.log_factory as LogFactory + +from ..utilities.tracking.sdk_tracker import SdkTracker +class BinLookupApi(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + Ref: https://github.com/swagger-api/swagger-codegen + """ + + def __init__(self, merchant_config, api_client=None): + config = Configuration() + if api_client: + self.api_client = api_client + else: + if not config.api_client: + config.api_client = ApiClient() + self.api_client = config.api_client + self.api_client.set_configuration(merchant_config) + self.logger = LogFactory.setup_logger(self.__class__.__name__, self.api_client.mconfig.log_config) + + + + def get_account_info(self, create_bin_lookup_request, **kwargs): + """ + BIN Lookup API + The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources. This service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses with a flexible choice of inputs such as primary account number (PAN), network token from major networks which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS). Currently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_account_info(create_bin_lookup_request, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param CreateBinLookupRequest create_bin_lookup_request: (required) + :return: InlineResponse2011 + If the method is called asynchronously, + returns the request thread. + + DISCLAIMER: + Cybersource may allow Customer to access, use, and/or test a Cybersource product or service that may still be in development or has not been market-tested ("Beta Product") solely for the purpose of evaluating the functionality or marketability of the Beta Product (a "Beta Evaluation"). Notwithstanding any language to the contrary, the following terms shall apply with respect to Customer's participation in any Beta Evaluation (and the Beta Product(s)) accessed thereunder): The Parties will enter into a separate form agreement detailing the scope of the Beta Evaluation, requirements, pricing, the length of the beta evaluation period ("Beta Product Form"). Beta Products are not, and may not become, Transaction Services and have not yet been publicly released and are offered for the sole purpose of internal testing and non-commercial evaluation. Customer's use of the Beta Product shall be solely for the purpose of conducting the Beta Evaluation. Customer accepts all risks arising out of the access and use of the Beta Products. Cybersource may, in its sole discretion, at any time, terminate or discontinue the Beta Evaluation. Customer acknowledges and agrees that any Beta Product may still be in development and that Beta Product is provided "AS IS" and may not perform at the level of a commercially available service, may not operate as expected and may be modified prior to release. CYBERSOURCE SHALL NOT BE RESPONSIBLE OR LIABLE UNDER ANY CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE RELATING TO A BETA PRODUCT OR THE BETA EVALUATION (A) FOR LOSS OR INACCURACY OF DATA OR COST OF PROCUREMENT OF SUBSTITUTE GOODS, SERVICES OR TECHNOLOGY, (B) ANY CLAIM, LOSSES, DAMAGES, OR CAUSE OF ACTION ARISING IN CONNECTION WITH THE BETA PRODUCT; OR (C) FOR ANY INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF REVENUES AND LOSS OF PROFITS. + """ + + if self.api_client.mconfig.log_config.enable_log: + self.logger.info("CALL TO METHOD `get_account_info` STARTED") + + kwargs['_return_http_data_only'] = True + if kwargs.get('callback'): + return self.get_account_info_with_http_info(create_bin_lookup_request, **kwargs) + else: + (data) = self.get_account_info_with_http_info(create_bin_lookup_request, **kwargs) + return data + + def get_account_info_with_http_info(self, create_bin_lookup_request, **kwargs): + """ + BIN Lookup API + The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources. This service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses with a flexible choice of inputs such as primary account number (PAN), network token from major networks which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS). Currently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant. + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please define a `callback` function + to be invoked when receiving the response. + >>> def callback_function(response): + >>> pprint(response) + >>> + >>> thread = api.get_account_info_with_http_info(create_bin_lookup_request, callback=callback_function) + + :param callback function: The callback function + for asynchronous request. (optional) + :param CreateBinLookupRequest create_bin_lookup_request: (required) + :return: InlineResponse2011 + If the method is called asynchronously, + returns the request thread. + """ + + all_params = ['create_bin_lookup_request'] + all_params.append('callback') + all_params.append('_return_http_data_only') + all_params.append('_preload_content') + all_params.append('_request_timeout') + + params = locals() + for key, val in iteritems(params['kwargs']): + if key not in all_params: + raise TypeError( + "Got an unexpected keyword argument '%s'" + " to method get_account_info" % key + ) + params[key] = val + del params['kwargs'] + # verify the required parameter 'create_bin_lookup_request' is set + if ('create_bin_lookup_request' not in params) or (params['create_bin_lookup_request'] is None): + if self.api_client.mconfig.log_config.enable_log: + self.logger.error("InvalidArgumentException : Missing the required parameter `create_bin_lookup_request` when calling `get_account_info`") + raise ValueError("Missing the required parameter `create_bin_lookup_request` when calling `get_account_info`") + + + collection_formats = {} + + path_params = {} + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'create_bin_lookup_request' in params: + body_params = params['create_bin_lookup_request'] + + sdkTracker = SdkTracker() + body_params = sdkTracker.insert_developer_id_tracker(body_params, 'create_bin_lookup_request', self.api_client.mconfig.run_environment) + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept(['application/hal+json;charset=utf-8']) + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type(['application/json;charset=utf-8']) + + # Authentication setting + auth_settings = [] + + return self.api_client.call_api(f'/bin/v1/binlookup', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='InlineResponse2011', + auth_settings=auth_settings, + callback=params.get('callback'), + _return_http_data_only=params.get('_return_http_data_only'), + _preload_content=params.get('_preload_content', True), + _request_timeout=params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/CyberSource/api/create_new_webhooks_api.py b/CyberSource/api/create_new_webhooks_api.py index c47ca975..b068d2be 100644 --- a/CyberSource/api/create_new_webhooks_api.py +++ b/CyberSource/api/create_new_webhooks_api.py @@ -59,7 +59,7 @@ def create_webhook_subscription(self, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param CreateWebhookRequest create_webhook_request: The webhook payload - :return: InlineResponse2013 + :return: InlineResponse2014 If the method is called asynchronously, returns the request thread. @@ -92,7 +92,7 @@ def create_webhook_subscription_with_http_info(self, **kwargs): :param callback function: The callback function for asynchronous request. (optional) :param CreateWebhookRequest create_webhook_request: The webhook payload - :return: InlineResponse2013 + :return: InlineResponse2014 If the method is called asynchronously, returns the request thread. """ @@ -147,7 +147,7 @@ def create_webhook_subscription_with_http_info(self, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2013', + response_type='InlineResponse2014', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), @@ -289,7 +289,7 @@ def save_sym_egress_key(self, v_c_sender_organization_id, v_c_permissions, **kwa :param str v_c_permissions: Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required) :param str v_c_correlation_id: A globally unique id associated with your request :param SaveSymEgressKey save_sym_egress_key: Provide egress Symmetric key information to save (create or store or refresh) - :return: InlineResponse2012 + :return: InlineResponse2013 If the method is called asynchronously, returns the request thread. @@ -325,7 +325,7 @@ def save_sym_egress_key_with_http_info(self, v_c_sender_organization_id, v_c_per :param str v_c_permissions: Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required) :param str v_c_correlation_id: A globally unique id associated with your request :param SaveSymEgressKey save_sym_egress_key: Provide egress Symmetric key information to save (create or store or refresh) - :return: InlineResponse2012 + :return: InlineResponse2013 If the method is called asynchronously, returns the request thread. """ @@ -396,7 +396,7 @@ def save_sym_egress_key_with_http_info(self, v_c_sender_organization_id, v_c_per body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2012', + response_type='InlineResponse2013', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/CyberSource/api/manage_webhooks_api.py b/CyberSource/api/manage_webhooks_api.py index 0ae6e7af..eb4e5eb3 100644 --- a/CyberSource/api/manage_webhooks_api.py +++ b/CyberSource/api/manage_webhooks_api.py @@ -427,7 +427,7 @@ def save_asym_egress_key(self, v_c_sender_organization_id, v_c_permissions, save :param str v_c_permissions: Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required) :param SaveAsymEgressKey save_asym_egress_key: Provide egress Asymmetric key information to save (create or store) (required) :param str v_c_correlation_id: A globally unique id associated with your request - :return: InlineResponse2014 + :return: InlineResponse2015 If the method is called asynchronously, returns the request thread. @@ -463,7 +463,7 @@ def save_asym_egress_key_with_http_info(self, v_c_sender_organization_id, v_c_pe :param str v_c_permissions: Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required) :param SaveAsymEgressKey save_asym_egress_key: Provide egress Asymmetric key information to save (create or store) (required) :param str v_c_correlation_id: A globally unique id associated with your request - :return: InlineResponse2014 + :return: InlineResponse2015 If the method is called asynchronously, returns the request thread. """ @@ -539,7 +539,7 @@ def save_asym_egress_key_with_http_info(self, v_c_sender_organization_id, v_c_pe body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2014', + response_type='InlineResponse2015', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/CyberSource/api/merchant_boarding_api.py b/CyberSource/api/merchant_boarding_api.py index 357d59dc..387fff03 100644 --- a/CyberSource/api/merchant_boarding_api.py +++ b/CyberSource/api/merchant_boarding_api.py @@ -176,7 +176,7 @@ def post_registration(self, post_registration_body, **kwargs): for asynchronous request. (optional) :param PostRegistrationBody post_registration_body: Boarding registration data (required) :param str v_c_idempotency_id: defines idempotency of the request - :return: InlineResponse2011 + :return: InlineResponse2012 If the method is called asynchronously, returns the request thread. @@ -210,7 +210,7 @@ def post_registration_with_http_info(self, post_registration_body, **kwargs): for asynchronous request. (optional) :param PostRegistrationBody post_registration_body: Boarding registration data (required) :param str v_c_idempotency_id: defines idempotency of the request - :return: InlineResponse2011 + :return: InlineResponse2012 If the method is called asynchronously, returns the request thread. """ @@ -272,7 +272,7 @@ def post_registration_with_http_info(self, post_registration_body, **kwargs): body=body_params, post_params=form_params, files=local_var_files, - response_type='InlineResponse2011', + response_type='InlineResponse2012', auth_settings=auth_settings, callback=params.get('callback'), _return_http_data_only=params.get('_return_http_data_only'), diff --git a/CyberSource/api/unified_checkout_capture_context_api.py b/CyberSource/api/unified_checkout_capture_context_api.py index a65020ef..d486cfec 100644 --- a/CyberSource/api/unified_checkout_capture_context_api.py +++ b/CyberSource/api/unified_checkout_capture_context_api.py @@ -47,7 +47,7 @@ def __init__(self, merchant_config, api_client=None): def generate_unified_checkout_capture_context(self, generate_unified_checkout_capture_context_request, **kwargs): """ Generate Unified Checkout Capture Context - Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). For more information about Click to Pay drop in UI, see the [Click to Pay Drop-in UI Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/click-to-pay/developer/all/rest/click-to-pay/ctp-intro.html). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page + Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. @@ -77,7 +77,7 @@ def generate_unified_checkout_capture_context(self, generate_unified_checkout_ca def generate_unified_checkout_capture_context_with_http_info(self, generate_unified_checkout_capture_context_request, **kwargs): """ Generate Unified Checkout Capture Context - Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). For more information about Click to Pay drop in UI, see the [Click to Pay Drop-in UI Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/click-to-pay/developer/all/rest/click-to-pay/ctp-intro.html). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page + Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a `callback` function to be invoked when receiving the response. diff --git a/CyberSource/models/__init__.py b/CyberSource/models/__init__.py index be531caf..f5b5da6c 100644 --- a/CyberSource/models/__init__.py +++ b/CyberSource/models/__init__.py @@ -25,6 +25,13 @@ from .activate_subscription_response_subscription_information import ActivateSubscriptionResponseSubscriptionInformation from .add_negative_list_request import AddNegativeListRequest from .auth_reversal_request import AuthReversalRequest +from .bin_lookupv400_response import BinLookupv400Response +from .binv1binlookup_client_reference_information import Binv1binlookupClientReferenceInformation +from .binv1binlookup_payment_information import Binv1binlookupPaymentInformation +from .binv1binlookup_payment_information_card import Binv1binlookupPaymentInformationCard +from .binv1binlookup_processing_information import Binv1binlookupProcessingInformation +from .binv1binlookup_processing_information_payout_options import Binv1binlookupProcessingInformationPayoutOptions +from .binv1binlookup_token_information import Binv1binlookupTokenInformation from .boardingv1registrations_document_information import Boardingv1registrationsDocumentInformation from .boardingv1registrations_document_information_signed_documents import Boardingv1registrationsDocumentInformationSignedDocuments from .boardingv1registrations_integration_information import Boardingv1registrationsIntegrationInformation @@ -79,6 +86,7 @@ from .commerce_solutions_products_token_management_configuration_information_configurations import CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurations from .create_adhoc_report_request import CreateAdhocReportRequest from .create_billing_agreement import CreateBillingAgreement +from .create_bin_lookup_request import CreateBinLookupRequest from .create_bundled_decision_manager_case_request import CreateBundledDecisionManagerCaseRequest from .create_credit_request import CreateCreditRequest from .create_invoice_request import CreateInvoiceRequest @@ -190,26 +198,36 @@ from .inline_response200_embedded_reversal_links_self import InlineResponse200EmbeddedReversalLinksSelf from .inline_response201 import InlineResponse201 from .inline_response2011 import InlineResponse2011 -from .inline_response2011_integration_information import InlineResponse2011IntegrationInformation -from .inline_response2011_integration_information_tenant_configurations import InlineResponse2011IntegrationInformationTenantConfigurations -from .inline_response2011_organization_information import InlineResponse2011OrganizationInformation -from .inline_response2011_product_information_setups import InlineResponse2011ProductInformationSetups -from .inline_response2011_registration_information import InlineResponse2011RegistrationInformation -from .inline_response2011_setups import InlineResponse2011Setups -from .inline_response2011_setups_commerce_solutions import InlineResponse2011SetupsCommerceSolutions -from .inline_response2011_setups_payments import InlineResponse2011SetupsPayments -from .inline_response2011_setups_payments_card_processing import InlineResponse2011SetupsPaymentsCardProcessing -from .inline_response2011_setups_payments_card_processing_configuration_status import InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus -from .inline_response2011_setups_payments_card_processing_subscription_status import InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus -from .inline_response2011_setups_payments_digital_payments import InlineResponse2011SetupsPaymentsDigitalPayments -from .inline_response2011_setups_risk import InlineResponse2011SetupsRisk -from .inline_response2011_setups_value_added_services import InlineResponse2011SetupsValueAddedServices +from .inline_response2011_issuer_information import InlineResponse2011IssuerInformation +from .inline_response2011_payment_account_information import InlineResponse2011PaymentAccountInformation +from .inline_response2011_payment_account_information_card import InlineResponse2011PaymentAccountInformationCard +from .inline_response2011_payment_account_information_card_brands import InlineResponse2011PaymentAccountInformationCardBrands +from .inline_response2011_payment_account_information_features import InlineResponse2011PaymentAccountInformationFeatures +from .inline_response2011_payment_account_information_network import InlineResponse2011PaymentAccountInformationNetwork +from .inline_response2011_payout_information import InlineResponse2011PayoutInformation +from .inline_response2011_payout_information_pull_funds import InlineResponse2011PayoutInformationPullFunds +from .inline_response2011_payout_information_push_funds import InlineResponse2011PayoutInformationPushFunds from .inline_response2012 import InlineResponse2012 -from .inline_response2012_key_information import InlineResponse2012KeyInformation -from .inline_response2012_key_information_error_information import InlineResponse2012KeyInformationErrorInformation -from .inline_response2012_key_information_error_information_details import InlineResponse2012KeyInformationErrorInformationDetails +from .inline_response2012_integration_information import InlineResponse2012IntegrationInformation +from .inline_response2012_integration_information_tenant_configurations import InlineResponse2012IntegrationInformationTenantConfigurations +from .inline_response2012_organization_information import InlineResponse2012OrganizationInformation +from .inline_response2012_product_information_setups import InlineResponse2012ProductInformationSetups +from .inline_response2012_registration_information import InlineResponse2012RegistrationInformation +from .inline_response2012_setups import InlineResponse2012Setups +from .inline_response2012_setups_commerce_solutions import InlineResponse2012SetupsCommerceSolutions +from .inline_response2012_setups_payments import InlineResponse2012SetupsPayments +from .inline_response2012_setups_payments_card_processing import InlineResponse2012SetupsPaymentsCardProcessing +from .inline_response2012_setups_payments_card_processing_configuration_status import InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus +from .inline_response2012_setups_payments_card_processing_subscription_status import InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus +from .inline_response2012_setups_payments_digital_payments import InlineResponse2012SetupsPaymentsDigitalPayments +from .inline_response2012_setups_risk import InlineResponse2012SetupsRisk +from .inline_response2012_setups_value_added_services import InlineResponse2012SetupsValueAddedServices from .inline_response2013 import InlineResponse2013 +from .inline_response2013_key_information import InlineResponse2013KeyInformation +from .inline_response2013_key_information_error_information import InlineResponse2013KeyInformationErrorInformation +from .inline_response2013_key_information_error_information_details import InlineResponse2013KeyInformationErrorInformationDetails from .inline_response2014 import InlineResponse2014 +from .inline_response2015 import InlineResponse2015 from .inline_response202 import InlineResponse202 from .inline_response202_links import InlineResponse202Links from .inline_response202_links_status import InlineResponse202LinksStatus @@ -529,6 +547,7 @@ from .pts_v2_payments_post201_response_payment_information_instrument_identifier import PtsV2PaymentsPost201ResponsePaymentInformationInstrumentIdentifier from .pts_v2_payments_post201_response_payment_information_tokenized_card import PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard from .pts_v2_payments_post201_response_payment_insights_information import PtsV2PaymentsPost201ResponsePaymentInsightsInformation +from .pts_v2_payments_post201_response_payment_insights_information_orchestration import PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration from .pts_v2_payments_post201_response_payment_insights_information_response_insights import PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights from .pts_v2_payments_post201_response_point_of_sale_information import PtsV2PaymentsPost201ResponsePointOfSaleInformation from .pts_v2_payments_post201_response_point_of_sale_information_emv import PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv @@ -724,6 +743,7 @@ from .ptsv2payments_payment_information_instrument_identifier import Ptsv2paymentsPaymentInformationInstrumentIdentifier from .ptsv2payments_payment_information_legacy_token import Ptsv2paymentsPaymentInformationLegacyToken from .ptsv2payments_payment_information_options import Ptsv2paymentsPaymentInformationOptions +from .ptsv2payments_payment_information_payment_account_reference import Ptsv2paymentsPaymentInformationPaymentAccountReference from .ptsv2payments_payment_information_payment_instrument import Ptsv2paymentsPaymentInformationPaymentInstrument from .ptsv2payments_payment_information_payment_type import Ptsv2paymentsPaymentInformationPaymentType from .ptsv2payments_payment_information_payment_type_method import Ptsv2paymentsPaymentInformationPaymentTypeMethod @@ -1230,7 +1250,6 @@ from .tss_v2_transactions_post201_response_embedded_risk_information_providers import TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders from .tss_v2_transactions_post201_response_embedded_risk_information_providers_fingerprint import TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint from .tss_v2_transactions_post201_response_embedded_transaction_summaries import TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries -from .tss_v2_transactions_post400_response import TssV2TransactionsPost400Response from .tssv2transactionsemv_tag_details_emv_details_list import Tssv2transactionsemvTagDetailsEmvDetailsList from .ums_v1_users_get200_response import UmsV1UsersGet200Response from .ums_v1_users_get200_response_account_information import UmsV1UsersGet200ResponseAccountInformation diff --git a/CyberSource/models/tss_v2_transactions_post400_response.py b/CyberSource/models/bin_lookupv400_response.py similarity index 78% rename from CyberSource/models/tss_v2_transactions_post400_response.py rename to CyberSource/models/bin_lookupv400_response.py index 3c20a130..1b5e7204 100644 --- a/CyberSource/models/tss_v2_transactions_post400_response.py +++ b/CyberSource/models/bin_lookupv400_response.py @@ -15,7 +15,7 @@ import re -class TssV2TransactionsPost400Response(object): +class BinLookupv400Response(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -45,7 +45,7 @@ class TssV2TransactionsPost400Response(object): def __init__(self, submit_time_utc=None, status=None, message=None, details=None): """ - TssV2TransactionsPost400Response - a model defined in Swagger + BinLookupv400Response - a model defined in Swagger """ self._submit_time_utc = None @@ -65,10 +65,10 @@ def __init__(self, submit_time_utc=None, status=None, message=None, details=None @property def submit_time_utc(self): """ - Gets the submit_time_utc of this TssV2TransactionsPost400Response. + Gets the submit_time_utc of this BinLookupv400Response. 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. - :return: The submit_time_utc of this TssV2TransactionsPost400Response. + :return: The submit_time_utc of this BinLookupv400Response. :rtype: str """ return self._submit_time_utc @@ -76,10 +76,10 @@ def submit_time_utc(self): @submit_time_utc.setter def submit_time_utc(self, submit_time_utc): """ - Sets the submit_time_utc of this TssV2TransactionsPost400Response. + Sets the submit_time_utc of this BinLookupv400Response. 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. - :param submit_time_utc: The submit_time_utc of this TssV2TransactionsPost400Response. + :param submit_time_utc: The submit_time_utc of this BinLookupv400Response. :type: str """ @@ -88,10 +88,10 @@ def submit_time_utc(self, submit_time_utc): @property def status(self): """ - Gets the status of this TssV2TransactionsPost400Response. + Gets the status of this BinLookupv400Response. The status of the submitted transaction. Possible values: - INVALID_REQUEST - :return: The status of this TssV2TransactionsPost400Response. + :return: The status of this BinLookupv400Response. :rtype: str """ return self._status @@ -99,10 +99,10 @@ def status(self): @status.setter def status(self, status): """ - Sets the status of this TssV2TransactionsPost400Response. + Sets the status of this BinLookupv400Response. The status of the submitted transaction. Possible values: - INVALID_REQUEST - :param status: The status of this TssV2TransactionsPost400Response. + :param status: The status of this BinLookupv400Response. :type: str """ @@ -111,10 +111,10 @@ def status(self, status): @property def message(self): """ - Gets the message of this TssV2TransactionsPost400Response. + Gets the message of this BinLookupv400Response. The detail message related to the status and reason listed above. - :return: The message of this TssV2TransactionsPost400Response. + :return: The message of this BinLookupv400Response. :rtype: str """ return self._message @@ -122,10 +122,10 @@ def message(self): @message.setter def message(self, message): """ - Sets the message of this TssV2TransactionsPost400Response. + Sets the message of this BinLookupv400Response. The detail message related to the status and reason listed above. - :param message: The message of this TssV2TransactionsPost400Response. + :param message: The message of this BinLookupv400Response. :type: str """ @@ -134,9 +134,9 @@ def message(self, message): @property def details(self): """ - Gets the details of this TssV2TransactionsPost400Response. + Gets the details of this BinLookupv400Response. - :return: The details of this TssV2TransactionsPost400Response. + :return: The details of this BinLookupv400Response. :rtype: list[PtsV2PaymentsPost201ResponseErrorInformationDetails] """ return self._details @@ -144,9 +144,9 @@ def details(self): @details.setter def details(self, details): """ - Sets the details of this TssV2TransactionsPost400Response. + Sets the details of this BinLookupv400Response. - :param details: The details of this TssV2TransactionsPost400Response. + :param details: The details of this BinLookupv400Response. :type: list[PtsV2PaymentsPost201ResponseErrorInformationDetails] """ @@ -194,7 +194,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, TssV2TransactionsPost400Response): + if not isinstance(other, BinLookupv400Response): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/binv1binlookup_client_reference_information.py b/CyberSource/models/binv1binlookup_client_reference_information.py new file mode 100644 index 00000000..6ce07254 --- /dev/null +++ b/CyberSource/models/binv1binlookup_client_reference_information.py @@ -0,0 +1,206 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class Binv1binlookupClientReferenceInformation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'partner': 'Riskv1decisionsClientReferenceInformationPartner', + 'application_name': 'str', + 'application_version': 'str', + 'application_user': 'str' + } + + attribute_map = { + 'partner': 'partner', + 'application_name': 'applicationName', + 'application_version': 'applicationVersion', + 'application_user': 'applicationUser' + } + + def __init__(self, partner=None, application_name=None, application_version=None, application_user=None): + """ + Binv1binlookupClientReferenceInformation - a model defined in Swagger + """ + + self._partner = None + self._application_name = None + self._application_version = None + self._application_user = None + + if partner is not None: + self.partner = partner + if application_name is not None: + self.application_name = application_name + if application_version is not None: + self.application_version = application_version + if application_user is not None: + self.application_user = application_user + + @property + def partner(self): + """ + Gets the partner of this Binv1binlookupClientReferenceInformation. + + :return: The partner of this Binv1binlookupClientReferenceInformation. + :rtype: Riskv1decisionsClientReferenceInformationPartner + """ + return self._partner + + @partner.setter + def partner(self, partner): + """ + Sets the partner of this Binv1binlookupClientReferenceInformation. + + :param partner: The partner of this Binv1binlookupClientReferenceInformation. + :type: Riskv1decisionsClientReferenceInformationPartner + """ + + self._partner = partner + + @property + def application_name(self): + """ + Gets the application_name of this Binv1binlookupClientReferenceInformation. + The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. + + :return: The application_name of this Binv1binlookupClientReferenceInformation. + :rtype: str + """ + return self._application_name + + @application_name.setter + def application_name(self, application_name): + """ + Sets the application_name of this Binv1binlookupClientReferenceInformation. + The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. + + :param application_name: The application_name of this Binv1binlookupClientReferenceInformation. + :type: str + """ + + self._application_name = application_name + + @property + def application_version(self): + """ + Gets the application_version of this Binv1binlookupClientReferenceInformation. + Version of the CyberSource application or integration used for a transaction. + + :return: The application_version of this Binv1binlookupClientReferenceInformation. + :rtype: str + """ + return self._application_version + + @application_version.setter + def application_version(self, application_version): + """ + Sets the application_version of this Binv1binlookupClientReferenceInformation. + Version of the CyberSource application or integration used for a transaction. + + :param application_version: The application_version of this Binv1binlookupClientReferenceInformation. + :type: str + """ + + self._application_version = application_version + + @property + def application_user(self): + """ + Gets the application_user of this Binv1binlookupClientReferenceInformation. + The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. + + :return: The application_user of this Binv1binlookupClientReferenceInformation. + :rtype: str + """ + return self._application_user + + @application_user.setter + def application_user(self, application_user): + """ + Sets the application_user of this Binv1binlookupClientReferenceInformation. + The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. + + :param application_user: The application_user of this Binv1binlookupClientReferenceInformation. + :type: str + """ + + self._application_user = application_user + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Binv1binlookupClientReferenceInformation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/binv1binlookup_payment_information.py b/CyberSource/models/binv1binlookup_payment_information.py new file mode 100644 index 00000000..9823c38c --- /dev/null +++ b/CyberSource/models/binv1binlookup_payment_information.py @@ -0,0 +1,200 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class Binv1binlookupPaymentInformation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'card': 'Binv1binlookupPaymentInformationCard', + 'customer': 'GetAllSubscriptionsResponsePaymentInformationCustomer', + 'payment_instrument': 'Ptsv2paymentsPaymentInformationPaymentInstrument', + 'instrument_identifier': 'Ptsv2paymentsPaymentInformationInstrumentIdentifier' + } + + attribute_map = { + 'card': 'card', + 'customer': 'customer', + 'payment_instrument': 'paymentInstrument', + 'instrument_identifier': 'instrumentIdentifier' + } + + def __init__(self, card=None, customer=None, payment_instrument=None, instrument_identifier=None): + """ + Binv1binlookupPaymentInformation - a model defined in Swagger + """ + + self._card = None + self._customer = None + self._payment_instrument = None + self._instrument_identifier = None + + if card is not None: + self.card = card + if customer is not None: + self.customer = customer + if payment_instrument is not None: + self.payment_instrument = payment_instrument + if instrument_identifier is not None: + self.instrument_identifier = instrument_identifier + + @property + def card(self): + """ + Gets the card of this Binv1binlookupPaymentInformation. + + :return: The card of this Binv1binlookupPaymentInformation. + :rtype: Binv1binlookupPaymentInformationCard + """ + return self._card + + @card.setter + def card(self, card): + """ + Sets the card of this Binv1binlookupPaymentInformation. + + :param card: The card of this Binv1binlookupPaymentInformation. + :type: Binv1binlookupPaymentInformationCard + """ + + self._card = card + + @property + def customer(self): + """ + Gets the customer of this Binv1binlookupPaymentInformation. + + :return: The customer of this Binv1binlookupPaymentInformation. + :rtype: GetAllSubscriptionsResponsePaymentInformationCustomer + """ + return self._customer + + @customer.setter + def customer(self, customer): + """ + Sets the customer of this Binv1binlookupPaymentInformation. + + :param customer: The customer of this Binv1binlookupPaymentInformation. + :type: GetAllSubscriptionsResponsePaymentInformationCustomer + """ + + self._customer = customer + + @property + def payment_instrument(self): + """ + Gets the payment_instrument of this Binv1binlookupPaymentInformation. + + :return: The payment_instrument of this Binv1binlookupPaymentInformation. + :rtype: Ptsv2paymentsPaymentInformationPaymentInstrument + """ + return self._payment_instrument + + @payment_instrument.setter + def payment_instrument(self, payment_instrument): + """ + Sets the payment_instrument of this Binv1binlookupPaymentInformation. + + :param payment_instrument: The payment_instrument of this Binv1binlookupPaymentInformation. + :type: Ptsv2paymentsPaymentInformationPaymentInstrument + """ + + self._payment_instrument = payment_instrument + + @property + def instrument_identifier(self): + """ + Gets the instrument_identifier of this Binv1binlookupPaymentInformation. + + :return: The instrument_identifier of this Binv1binlookupPaymentInformation. + :rtype: Ptsv2paymentsPaymentInformationInstrumentIdentifier + """ + return self._instrument_identifier + + @instrument_identifier.setter + def instrument_identifier(self, instrument_identifier): + """ + Sets the instrument_identifier of this Binv1binlookupPaymentInformation. + + :param instrument_identifier: The instrument_identifier of this Binv1binlookupPaymentInformation. + :type: Ptsv2paymentsPaymentInformationInstrumentIdentifier + """ + + self._instrument_identifier = instrument_identifier + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Binv1binlookupPaymentInformation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/binv1binlookup_payment_information_card.py b/CyberSource/models/binv1binlookup_payment_information_card.py new file mode 100644 index 00000000..8c930fc2 --- /dev/null +++ b/CyberSource/models/binv1binlookup_payment_information_card.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class Binv1binlookupPaymentInformationCard(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'number': 'str' + } + + attribute_map = { + 'number': 'number' + } + + def __init__(self, number=None): + """ + Binv1binlookupPaymentInformationCard - a model defined in Swagger + """ + + self._number = None + + if number is not None: + self.number = number + + @property + def number(self): + """ + Gets the number of this Binv1binlookupPaymentInformationCard. + The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. + + :return: The number of this Binv1binlookupPaymentInformationCard. + :rtype: str + """ + return self._number + + @number.setter + def number(self, number): + """ + Sets the number of this Binv1binlookupPaymentInformationCard. + The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. + + :param number: The number of this Binv1binlookupPaymentInformationCard. + :type: str + """ + + self._number = number + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Binv1binlookupPaymentInformationCard): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/binv1binlookup_processing_information.py b/CyberSource/models/binv1binlookup_processing_information.py new file mode 100644 index 00000000..7a3d9574 --- /dev/null +++ b/CyberSource/models/binv1binlookup_processing_information.py @@ -0,0 +1,150 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class Binv1binlookupProcessingInformation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'bin_source': 'str', + 'payout_options': 'Binv1binlookupProcessingInformationPayoutOptions' + } + + attribute_map = { + 'bin_source': 'binSource', + 'payout_options': 'payoutOptions' + } + + def __init__(self, bin_source=None, payout_options=None): + """ + Binv1binlookupProcessingInformation - a model defined in Swagger + """ + + self._bin_source = None + self._payout_options = None + + if bin_source is not None: + self.bin_source = bin_source + if payout_options is not None: + self.payout_options = payout_options + + @property + def bin_source(self): + """ + Gets the bin_source of this Binv1binlookupProcessingInformation. + Bin Source File Identifier. Possible values: - itmx - rupay + + :return: The bin_source of this Binv1binlookupProcessingInformation. + :rtype: str + """ + return self._bin_source + + @bin_source.setter + def bin_source(self, bin_source): + """ + Sets the bin_source of this Binv1binlookupProcessingInformation. + Bin Source File Identifier. Possible values: - itmx - rupay + + :param bin_source: The bin_source of this Binv1binlookupProcessingInformation. + :type: str + """ + + self._bin_source = bin_source + + @property + def payout_options(self): + """ + Gets the payout_options of this Binv1binlookupProcessingInformation. + + :return: The payout_options of this Binv1binlookupProcessingInformation. + :rtype: Binv1binlookupProcessingInformationPayoutOptions + """ + return self._payout_options + + @payout_options.setter + def payout_options(self, payout_options): + """ + Sets the payout_options of this Binv1binlookupProcessingInformation. + + :param payout_options: The payout_options of this Binv1binlookupProcessingInformation. + :type: Binv1binlookupProcessingInformationPayoutOptions + """ + + self._payout_options = payout_options + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Binv1binlookupProcessingInformation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/binv1binlookup_processing_information_payout_options.py b/CyberSource/models/binv1binlookup_processing_information_payout_options.py new file mode 100644 index 00000000..9fa265c2 --- /dev/null +++ b/CyberSource/models/binv1binlookup_processing_information_payout_options.py @@ -0,0 +1,180 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class Binv1binlookupProcessingInformationPayoutOptions(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'payout_inquiry': 'bool', + 'network_id': 'str', + 'acquirer_bin': 'str' + } + + attribute_map = { + 'payout_inquiry': 'payoutInquiry', + 'network_id': 'networkId', + 'acquirer_bin': 'acquirerBin' + } + + def __init__(self, payout_inquiry=None, network_id=None, acquirer_bin=None): + """ + Binv1binlookupProcessingInformationPayoutOptions - a model defined in Swagger + """ + + self._payout_inquiry = None + self._network_id = None + self._acquirer_bin = None + + if payout_inquiry is not None: + self.payout_inquiry = payout_inquiry + if network_id is not None: + self.network_id = network_id + if acquirer_bin is not None: + self.acquirer_bin = acquirer_bin + + @property + def payout_inquiry(self): + """ + Gets the payout_inquiry of this Binv1binlookupProcessingInformationPayoutOptions. + If `true` then provide attributes related to fund transfer/payouts. If payout information not found then response will have standard account lookup. Possible values: - true - false + + :return: The payout_inquiry of this Binv1binlookupProcessingInformationPayoutOptions. + :rtype: bool + """ + return self._payout_inquiry + + @payout_inquiry.setter + def payout_inquiry(self, payout_inquiry): + """ + Sets the payout_inquiry of this Binv1binlookupProcessingInformationPayoutOptions. + If `true` then provide attributes related to fund transfer/payouts. If payout information not found then response will have standard account lookup. Possible values: - true - false + + :param payout_inquiry: The payout_inquiry of this Binv1binlookupProcessingInformationPayoutOptions. + :type: bool + """ + + self._payout_inquiry = payout_inquiry + + @property + def network_id(self): + """ + Gets the network_id of this Binv1binlookupProcessingInformationPayoutOptions. + The networks specified in this field must be a subset of the information provided during program enrollment Possible values: - 0020 : Accel/Exchange - 0024 : CU24 - 0003 : Interlink - 0016 : Maestro - 0018 : NYCE - 0027 : NYCE - 0009 : Pulse - 0017 : Pulse - 0019 : Pulse - 0008 : Star - 0010 : Star - 0011 : Star - 0012 : Star - 0015 : Star - 0002 : Visa/PLUS + + :return: The network_id of this Binv1binlookupProcessingInformationPayoutOptions. + :rtype: str + """ + return self._network_id + + @network_id.setter + def network_id(self, network_id): + """ + Sets the network_id of this Binv1binlookupProcessingInformationPayoutOptions. + The networks specified in this field must be a subset of the information provided during program enrollment Possible values: - 0020 : Accel/Exchange - 0024 : CU24 - 0003 : Interlink - 0016 : Maestro - 0018 : NYCE - 0027 : NYCE - 0009 : Pulse - 0017 : Pulse - 0019 : Pulse - 0008 : Star - 0010 : Star - 0011 : Star - 0012 : Star - 0015 : Star - 0002 : Visa/PLUS + + :param network_id: The network_id of this Binv1binlookupProcessingInformationPayoutOptions. + :type: str + """ + + self._network_id = network_id + + @property + def acquirer_bin(self): + """ + Gets the acquirer_bin of this Binv1binlookupProcessingInformationPayoutOptions. + BIN under which the Funds Transfer application is registered. This must match the information provided during enrollment. + + :return: The acquirer_bin of this Binv1binlookupProcessingInformationPayoutOptions. + :rtype: str + """ + return self._acquirer_bin + + @acquirer_bin.setter + def acquirer_bin(self, acquirer_bin): + """ + Sets the acquirer_bin of this Binv1binlookupProcessingInformationPayoutOptions. + BIN under which the Funds Transfer application is registered. This must match the information provided during enrollment. + + :param acquirer_bin: The acquirer_bin of this Binv1binlookupProcessingInformationPayoutOptions. + :type: str + """ + + self._acquirer_bin = acquirer_bin + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Binv1binlookupProcessingInformationPayoutOptions): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/binv1binlookup_token_information.py b/CyberSource/models/binv1binlookup_token_information.py new file mode 100644 index 00000000..551ccbfa --- /dev/null +++ b/CyberSource/models/binv1binlookup_token_information.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class Binv1binlookupTokenInformation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'jti': 'str', + 'transient_token_jwt': 'str' + } + + attribute_map = { + 'jti': 'jti', + 'transient_token_jwt': 'transientTokenJwt' + } + + def __init__(self, jti=None, transient_token_jwt=None): + """ + Binv1binlookupTokenInformation - a model defined in Swagger + """ + + self._jti = None + self._transient_token_jwt = None + + if jti is not None: + self.jti = jti + if transient_token_jwt is not None: + self.transient_token_jwt = transient_token_jwt + + @property + def jti(self): + """ + Gets the jti of this Binv1binlookupTokenInformation. + TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). + + :return: The jti of this Binv1binlookupTokenInformation. + :rtype: str + """ + return self._jti + + @jti.setter + def jti(self, jti): + """ + Sets the jti of this Binv1binlookupTokenInformation. + TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). + + :param jti: The jti of this Binv1binlookupTokenInformation. + :type: str + """ + + self._jti = jti + + @property + def transient_token_jwt(self): + """ + Gets the transient_token_jwt of this Binv1binlookupTokenInformation. + Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result. + + :return: The transient_token_jwt of this Binv1binlookupTokenInformation. + :rtype: str + """ + return self._transient_token_jwt + + @transient_token_jwt.setter + def transient_token_jwt(self, transient_token_jwt): + """ + Sets the transient_token_jwt of this Binv1binlookupTokenInformation. + Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result. + + :param transient_token_jwt: The transient_token_jwt of this Binv1binlookupTokenInformation. + :type: str + """ + + self._transient_token_jwt = transient_token_jwt + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Binv1binlookupTokenInformation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/create_bin_lookup_request.py b/CyberSource/models/create_bin_lookup_request.py new file mode 100644 index 00000000..740c1912 --- /dev/null +++ b/CyberSource/models/create_bin_lookup_request.py @@ -0,0 +1,200 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class CreateBinLookupRequest(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'client_reference_information': 'Binv1binlookupClientReferenceInformation', + 'payment_information': 'Binv1binlookupPaymentInformation', + 'token_information': 'Binv1binlookupTokenInformation', + 'processing_information': 'Binv1binlookupProcessingInformation' + } + + attribute_map = { + 'client_reference_information': 'clientReferenceInformation', + 'payment_information': 'paymentInformation', + 'token_information': 'tokenInformation', + 'processing_information': 'processingInformation' + } + + def __init__(self, client_reference_information=None, payment_information=None, token_information=None, processing_information=None): + """ + CreateBinLookupRequest - a model defined in Swagger + """ + + self._client_reference_information = None + self._payment_information = None + self._token_information = None + self._processing_information = None + + if client_reference_information is not None: + self.client_reference_information = client_reference_information + if payment_information is not None: + self.payment_information = payment_information + if token_information is not None: + self.token_information = token_information + if processing_information is not None: + self.processing_information = processing_information + + @property + def client_reference_information(self): + """ + Gets the client_reference_information of this CreateBinLookupRequest. + + :return: The client_reference_information of this CreateBinLookupRequest. + :rtype: Binv1binlookupClientReferenceInformation + """ + return self._client_reference_information + + @client_reference_information.setter + def client_reference_information(self, client_reference_information): + """ + Sets the client_reference_information of this CreateBinLookupRequest. + + :param client_reference_information: The client_reference_information of this CreateBinLookupRequest. + :type: Binv1binlookupClientReferenceInformation + """ + + self._client_reference_information = client_reference_information + + @property + def payment_information(self): + """ + Gets the payment_information of this CreateBinLookupRequest. + + :return: The payment_information of this CreateBinLookupRequest. + :rtype: Binv1binlookupPaymentInformation + """ + return self._payment_information + + @payment_information.setter + def payment_information(self, payment_information): + """ + Sets the payment_information of this CreateBinLookupRequest. + + :param payment_information: The payment_information of this CreateBinLookupRequest. + :type: Binv1binlookupPaymentInformation + """ + + self._payment_information = payment_information + + @property + def token_information(self): + """ + Gets the token_information of this CreateBinLookupRequest. + + :return: The token_information of this CreateBinLookupRequest. + :rtype: Binv1binlookupTokenInformation + """ + return self._token_information + + @token_information.setter + def token_information(self, token_information): + """ + Sets the token_information of this CreateBinLookupRequest. + + :param token_information: The token_information of this CreateBinLookupRequest. + :type: Binv1binlookupTokenInformation + """ + + self._token_information = token_information + + @property + def processing_information(self): + """ + Gets the processing_information of this CreateBinLookupRequest. + + :return: The processing_information of this CreateBinLookupRequest. + :rtype: Binv1binlookupProcessingInformation + """ + return self._processing_information + + @processing_information.setter + def processing_information(self, processing_information): + """ + Sets the processing_information of this CreateBinLookupRequest. + + :param processing_information: The processing_information of this CreateBinLookupRequest. + :type: Binv1binlookupProcessingInformation + """ + + self._processing_information = processing_information + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, CreateBinLookupRequest): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response2002.py b/CyberSource/models/inline_response2002.py index dbb45756..4cdd64d8 100644 --- a/CyberSource/models/inline_response2002.py +++ b/CyberSource/models/inline_response2002.py @@ -34,7 +34,7 @@ class InlineResponse2002(object): 'integration_information': 'InlineResponse2002IntegrationInformation', 'organization_information': 'Boardingv1registrationsOrganizationInformation', 'product_information': 'Boardingv1registrationsProductInformation', - 'product_information_setups': 'list[InlineResponse2011ProductInformationSetups]', + 'product_information_setups': 'list[InlineResponse2012ProductInformationSetups]', 'document_information': 'Boardingv1registrationsDocumentInformation', 'details': 'dict(str, list[object])' } @@ -167,7 +167,7 @@ def product_information_setups(self): Gets the product_information_setups of this InlineResponse2002. :return: The product_information_setups of this InlineResponse2002. - :rtype: list[InlineResponse2011ProductInformationSetups] + :rtype: list[InlineResponse2012ProductInformationSetups] """ return self._product_information_setups @@ -177,7 +177,7 @@ def product_information_setups(self, product_information_setups): Sets the product_information_setups of this InlineResponse2002. :param product_information_setups: The product_information_setups of this InlineResponse2002. - :type: list[InlineResponse2011ProductInformationSetups] + :type: list[InlineResponse2012ProductInformationSetups] """ self._product_information_setups = product_information_setups diff --git a/CyberSource/models/inline_response2011.py b/CyberSource/models/inline_response2011.py index c47a9b44..5b6df0f9 100644 --- a/CyberSource/models/inline_response2011.py +++ b/CyberSource/models/inline_response2011.py @@ -31,29 +31,23 @@ class InlineResponse2011(object): """ swagger_types = { 'id': 'str', - 'submit_time_utc': 'date', + 'submit_time_utc': 'str', 'status': 'str', - 'registration_information': 'InlineResponse2011RegistrationInformation', - 'integration_information': 'InlineResponse2011IntegrationInformation', - 'organization_information': 'InlineResponse2011OrganizationInformation', - 'product_information_setups': 'list[InlineResponse2011ProductInformationSetups]', - 'message': 'str', - 'details': 'dict(str, list[object])' + 'payment_account_information': 'InlineResponse2011PaymentAccountInformation', + 'issuer_information': 'InlineResponse2011IssuerInformation', + 'payout_information': 'InlineResponse2011PayoutInformation' } attribute_map = { 'id': 'id', 'submit_time_utc': 'submitTimeUtc', 'status': 'status', - 'registration_information': 'registrationInformation', - 'integration_information': 'integrationInformation', - 'organization_information': 'organizationInformation', - 'product_information_setups': 'productInformationSetups', - 'message': 'message', - 'details': 'details' + 'payment_account_information': 'paymentAccountInformation', + 'issuer_information': 'issuerInformation', + 'payout_information': 'payoutInformation' } - def __init__(self, id=None, submit_time_utc=None, status=None, registration_information=None, integration_information=None, organization_information=None, product_information_setups=None, message=None, details=None): + def __init__(self, id=None, submit_time_utc=None, status=None, payment_account_information=None, issuer_information=None, payout_information=None): """ InlineResponse2011 - a model defined in Swagger """ @@ -61,12 +55,9 @@ def __init__(self, id=None, submit_time_utc=None, status=None, registration_info self._id = None self._submit_time_utc = None self._status = None - self._registration_information = None - self._integration_information = None - self._organization_information = None - self._product_information_setups = None - self._message = None - self._details = None + self._payment_account_information = None + self._issuer_information = None + self._payout_information = None if id is not None: self.id = id @@ -74,23 +65,18 @@ def __init__(self, id=None, submit_time_utc=None, status=None, registration_info self.submit_time_utc = submit_time_utc if status is not None: self.status = status - if registration_information is not None: - self.registration_information = registration_information - if integration_information is not None: - self.integration_information = integration_information - if organization_information is not None: - self.organization_information = organization_information - if product_information_setups is not None: - self.product_information_setups = product_information_setups - if message is not None: - self.message = message - if details is not None: - self.details = details + if payment_account_information is not None: + self.payment_account_information = payment_account_information + if issuer_information is not None: + self.issuer_information = issuer_information + if payout_information is not None: + self.payout_information = payout_information @property def id(self): """ Gets the id of this InlineResponse2011. + 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. :return: The id of this InlineResponse2011. :rtype: str @@ -101,6 +87,7 @@ def id(self): def id(self, id): """ Sets the id of this InlineResponse2011. + 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. :param id: The id of this InlineResponse2011. :type: str @@ -112,10 +99,10 @@ def id(self, id): def submit_time_utc(self): """ Gets the submit_time_utc of this InlineResponse2011. - 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. + 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. :return: The submit_time_utc of this InlineResponse2011. - :rtype: date + :rtype: str """ return self._submit_time_utc @@ -123,10 +110,10 @@ def submit_time_utc(self): def submit_time_utc(self, submit_time_utc): """ Sets the submit_time_utc of this InlineResponse2011. - 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. + 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. :param submit_time_utc: The submit_time_utc of this InlineResponse2011. - :type: date + :type: str """ self._submit_time_utc = submit_time_utc @@ -135,7 +122,7 @@ def submit_time_utc(self, submit_time_utc): def status(self): """ Gets the status of this InlineResponse2011. - The status of Registration request Possible Values: - 'INITIALIZED' - 'RECEIVED' - 'PROCESSING' - 'SUCCESS' - 'FAILURE' - 'PARTIAL' + The status of the submitted transaction. Possible values: - COMPLETED - MULTIPLE - NO MATCH :return: The status of this InlineResponse2011. :rtype: str @@ -146,145 +133,76 @@ def status(self): def status(self, status): """ Sets the status of this InlineResponse2011. - The status of Registration request Possible Values: - 'INITIALIZED' - 'RECEIVED' - 'PROCESSING' - 'SUCCESS' - 'FAILURE' - 'PARTIAL' + The status of the submitted transaction. Possible values: - COMPLETED - MULTIPLE - NO MATCH :param status: The status of this InlineResponse2011. :type: str """ - allowed_values = ["INITIALIZED", "RECEIVED", "PROCESSING", "SUCCESS", "FAILURE", "PARTIAL"] - if status not in allowed_values: - raise ValueError( - "Invalid value for `status` ({0}), must be one of {1}" - .format(status, allowed_values) - ) self._status = status @property - def registration_information(self): - """ - Gets the registration_information of this InlineResponse2011. - - :return: The registration_information of this InlineResponse2011. - :rtype: InlineResponse2011RegistrationInformation - """ - return self._registration_information - - @registration_information.setter - def registration_information(self, registration_information): - """ - Sets the registration_information of this InlineResponse2011. - - :param registration_information: The registration_information of this InlineResponse2011. - :type: InlineResponse2011RegistrationInformation - """ - - self._registration_information = registration_information - - @property - def integration_information(self): - """ - Gets the integration_information of this InlineResponse2011. - - :return: The integration_information of this InlineResponse2011. - :rtype: InlineResponse2011IntegrationInformation - """ - return self._integration_information - - @integration_information.setter - def integration_information(self, integration_information): - """ - Sets the integration_information of this InlineResponse2011. - - :param integration_information: The integration_information of this InlineResponse2011. - :type: InlineResponse2011IntegrationInformation - """ - - self._integration_information = integration_information - - @property - def organization_information(self): + def payment_account_information(self): """ - Gets the organization_information of this InlineResponse2011. + Gets the payment_account_information of this InlineResponse2011. - :return: The organization_information of this InlineResponse2011. - :rtype: InlineResponse2011OrganizationInformation + :return: The payment_account_information of this InlineResponse2011. + :rtype: InlineResponse2011PaymentAccountInformation """ - return self._organization_information + return self._payment_account_information - @organization_information.setter - def organization_information(self, organization_information): + @payment_account_information.setter + def payment_account_information(self, payment_account_information): """ - Sets the organization_information of this InlineResponse2011. + Sets the payment_account_information of this InlineResponse2011. - :param organization_information: The organization_information of this InlineResponse2011. - :type: InlineResponse2011OrganizationInformation + :param payment_account_information: The payment_account_information of this InlineResponse2011. + :type: InlineResponse2011PaymentAccountInformation """ - self._organization_information = organization_information + self._payment_account_information = payment_account_information @property - def product_information_setups(self): + def issuer_information(self): """ - Gets the product_information_setups of this InlineResponse2011. + Gets the issuer_information of this InlineResponse2011. - :return: The product_information_setups of this InlineResponse2011. - :rtype: list[InlineResponse2011ProductInformationSetups] + :return: The issuer_information of this InlineResponse2011. + :rtype: InlineResponse2011IssuerInformation """ - return self._product_information_setups + return self._issuer_information - @product_information_setups.setter - def product_information_setups(self, product_information_setups): + @issuer_information.setter + def issuer_information(self, issuer_information): """ - Sets the product_information_setups of this InlineResponse2011. + Sets the issuer_information of this InlineResponse2011. - :param product_information_setups: The product_information_setups of this InlineResponse2011. - :type: list[InlineResponse2011ProductInformationSetups] - """ - - self._product_information_setups = product_information_setups - - @property - def message(self): - """ - Gets the message of this InlineResponse2011. - - :return: The message of this InlineResponse2011. - :rtype: str - """ - return self._message - - @message.setter - def message(self, message): - """ - Sets the message of this InlineResponse2011. - - :param message: The message of this InlineResponse2011. - :type: str + :param issuer_information: The issuer_information of this InlineResponse2011. + :type: InlineResponse2011IssuerInformation """ - self._message = message + self._issuer_information = issuer_information @property - def details(self): + def payout_information(self): """ - Gets the details of this InlineResponse2011. + Gets the payout_information of this InlineResponse2011. - :return: The details of this InlineResponse2011. - :rtype: dict(str, list[object]) + :return: The payout_information of this InlineResponse2011. + :rtype: InlineResponse2011PayoutInformation """ - return self._details + return self._payout_information - @details.setter - def details(self, details): + @payout_information.setter + def payout_information(self, payout_information): """ - Sets the details of this InlineResponse2011. + Sets the payout_information of this InlineResponse2011. - :param details: The details of this InlineResponse2011. - :type: dict(str, list[object]) + :param payout_information: The payout_information of this InlineResponse2011. + :type: InlineResponse2011PayoutInformation """ - self._details = details + self._payout_information = payout_information def to_dict(self): """ diff --git a/CyberSource/models/inline_response2011_issuer_information.py b/CyberSource/models/inline_response2011_issuer_information.py new file mode 100644 index 00000000..0fc40e4c --- /dev/null +++ b/CyberSource/models/inline_response2011_issuer_information.py @@ -0,0 +1,236 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse2011IssuerInformation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'name': 'str', + 'country': 'str', + 'bin_length': 'str', + 'account_prefix': 'str', + 'phone_number': 'str' + } + + attribute_map = { + 'name': 'name', + 'country': 'country', + 'bin_length': 'binLength', + 'account_prefix': 'accountPrefix', + 'phone_number': 'phoneNumber' + } + + def __init__(self, name=None, country=None, bin_length=None, account_prefix=None, phone_number=None): + """ + InlineResponse2011IssuerInformation - a model defined in Swagger + """ + + self._name = None + self._country = None + self._bin_length = None + self._account_prefix = None + self._phone_number = None + + if name is not None: + self.name = name + if country is not None: + self.country = country + if bin_length is not None: + self.bin_length = bin_length + if account_prefix is not None: + self.account_prefix = account_prefix + if phone_number is not None: + self.phone_number = phone_number + + @property + def name(self): + """ + Gets the name of this InlineResponse2011IssuerInformation. + This field contains the issuer name. + + :return: The name of this InlineResponse2011IssuerInformation. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this InlineResponse2011IssuerInformation. + This field contains the issuer name. + + :param name: The name of this InlineResponse2011IssuerInformation. + :type: str + """ + + self._name = name + + @property + def country(self): + """ + Gets the country of this InlineResponse2011IssuerInformation. + This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer. + + :return: The country of this InlineResponse2011IssuerInformation. + :rtype: str + """ + return self._country + + @country.setter + def country(self, country): + """ + Sets the country of this InlineResponse2011IssuerInformation. + This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer. + + :param country: The country of this InlineResponse2011IssuerInformation. + :type: str + """ + + self._country = country + + @property + def bin_length(self): + """ + Gets the bin_length of this InlineResponse2011IssuerInformation. + This field contains the length of the BIN. + + :return: The bin_length of this InlineResponse2011IssuerInformation. + :rtype: str + """ + return self._bin_length + + @bin_length.setter + def bin_length(self, bin_length): + """ + Sets the bin_length of this InlineResponse2011IssuerInformation. + This field contains the length of the BIN. + + :param bin_length: The bin_length of this InlineResponse2011IssuerInformation. + :type: str + """ + + self._bin_length = bin_length + + @property + def account_prefix(self): + """ + Gets the account_prefix of this InlineResponse2011IssuerInformation. + This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers). + + :return: The account_prefix of this InlineResponse2011IssuerInformation. + :rtype: str + """ + return self._account_prefix + + @account_prefix.setter + def account_prefix(self, account_prefix): + """ + Sets the account_prefix of this InlineResponse2011IssuerInformation. + This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers). + + :param account_prefix: The account_prefix of this InlineResponse2011IssuerInformation. + :type: str + """ + + self._account_prefix = account_prefix + + @property + def phone_number(self): + """ + Gets the phone_number of this InlineResponse2011IssuerInformation. + This field contains the customer service phone number for the issuer. + + :return: The phone_number of this InlineResponse2011IssuerInformation. + :rtype: str + """ + return self._phone_number + + @phone_number.setter + def phone_number(self, phone_number): + """ + Sets the phone_number of this InlineResponse2011IssuerInformation. + This field contains the customer service phone number for the issuer. + + :param phone_number: The phone_number of this InlineResponse2011IssuerInformation. + :type: str + """ + + self._phone_number = phone_number + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse2011IssuerInformation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response2011_payment_account_information.py b/CyberSource/models/inline_response2011_payment_account_information.py new file mode 100644 index 00000000..2d88450e --- /dev/null +++ b/CyberSource/models/inline_response2011_payment_account_information.py @@ -0,0 +1,174 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse2011PaymentAccountInformation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'card': 'InlineResponse2011PaymentAccountInformationCard', + 'features': 'InlineResponse2011PaymentAccountInformationFeatures', + 'network': 'InlineResponse2011PaymentAccountInformationNetwork' + } + + attribute_map = { + 'card': 'card', + 'features': 'features', + 'network': 'network' + } + + def __init__(self, card=None, features=None, network=None): + """ + InlineResponse2011PaymentAccountInformation - a model defined in Swagger + """ + + self._card = None + self._features = None + self._network = None + + if card is not None: + self.card = card + if features is not None: + self.features = features + if network is not None: + self.network = network + + @property + def card(self): + """ + Gets the card of this InlineResponse2011PaymentAccountInformation. + + :return: The card of this InlineResponse2011PaymentAccountInformation. + :rtype: InlineResponse2011PaymentAccountInformationCard + """ + return self._card + + @card.setter + def card(self, card): + """ + Sets the card of this InlineResponse2011PaymentAccountInformation. + + :param card: The card of this InlineResponse2011PaymentAccountInformation. + :type: InlineResponse2011PaymentAccountInformationCard + """ + + self._card = card + + @property + def features(self): + """ + Gets the features of this InlineResponse2011PaymentAccountInformation. + + :return: The features of this InlineResponse2011PaymentAccountInformation. + :rtype: InlineResponse2011PaymentAccountInformationFeatures + """ + return self._features + + @features.setter + def features(self, features): + """ + Sets the features of this InlineResponse2011PaymentAccountInformation. + + :param features: The features of this InlineResponse2011PaymentAccountInformation. + :type: InlineResponse2011PaymentAccountInformationFeatures + """ + + self._features = features + + @property + def network(self): + """ + Gets the network of this InlineResponse2011PaymentAccountInformation. + + :return: The network of this InlineResponse2011PaymentAccountInformation. + :rtype: InlineResponse2011PaymentAccountInformationNetwork + """ + return self._network + + @network.setter + def network(self, network): + """ + Sets the network of this InlineResponse2011PaymentAccountInformation. + + :param network: The network of this InlineResponse2011PaymentAccountInformation. + :type: InlineResponse2011PaymentAccountInformationNetwork + """ + + self._network = network + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse2011PaymentAccountInformation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response2011_payment_account_information_card.py b/CyberSource/models/inline_response2011_payment_account_information_card.py new file mode 100644 index 00000000..f499f772 --- /dev/null +++ b/CyberSource/models/inline_response2011_payment_account_information_card.py @@ -0,0 +1,264 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse2011PaymentAccountInformationCard(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'type': 'str', + 'brand_name': 'str', + 'currency': 'str', + 'max_length': 'str', + 'credential_type': 'str', + 'brands': 'list[InlineResponse2011PaymentAccountInformationCardBrands]' + } + + attribute_map = { + 'type': 'type', + 'brand_name': 'brandName', + 'currency': 'currency', + 'max_length': 'maxLength', + 'credential_type': 'credentialType', + 'brands': 'brands' + } + + def __init__(self, type=None, brand_name=None, currency=None, max_length=None, credential_type=None, brands=None): + """ + InlineResponse2011PaymentAccountInformationCard - a model defined in Swagger + """ + + self._type = None + self._brand_name = None + self._currency = None + self._max_length = None + self._credential_type = None + self._brands = None + + if type is not None: + self.type = type + if brand_name is not None: + self.brand_name = brand_name + if currency is not None: + self.currency = currency + if max_length is not None: + self.max_length = max_length + if credential_type is not None: + self.credential_type = credential_type + if brands is not None: + self.brands = brands + + @property + def type(self): + """ + Gets the type of this InlineResponse2011PaymentAccountInformationCard. + This field contains the 3-digit value that indicates the card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: Enroute[^1] - `015`: Lowes Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Switch/Solo - `025`: Sams Club Consumer - `026`: Sams Club Business - `027`: Nicos - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `032`: Solo - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style - `046`: J.Crew - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo[^3] - `055`: Capital One Private Label - `058`: Carnet - `059`: ValueLink - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. + + :return: The type of this InlineResponse2011PaymentAccountInformationCard. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this InlineResponse2011PaymentAccountInformationCard. + This field contains the 3-digit value that indicates the card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: Enroute[^1] - `015`: Lowes Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Switch/Solo - `025`: Sams Club Consumer - `026`: Sams Club Business - `027`: Nicos - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `032`: Solo - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style - `046`: J.Crew - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo[^3] - `055`: Capital One Private Label - `058`: Carnet - `059`: ValueLink - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. + + :param type: The type of this InlineResponse2011PaymentAccountInformationCard. + :type: str + """ + + self._type = type + + @property + def brand_name(self): + """ + Gets the brand_name of this InlineResponse2011PaymentAccountInformationCard. + This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS + + :return: The brand_name of this InlineResponse2011PaymentAccountInformationCard. + :rtype: str + """ + return self._brand_name + + @brand_name.setter + def brand_name(self, brand_name): + """ + Sets the brand_name of this InlineResponse2011PaymentAccountInformationCard. + This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS + + :param brand_name: The brand_name of this InlineResponse2011PaymentAccountInformationCard. + :type: str + """ + + self._brand_name = brand_name + + @property + def currency(self): + """ + Gets the currency of this InlineResponse2011PaymentAccountInformationCard. + This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. + + :return: The currency of this InlineResponse2011PaymentAccountInformationCard. + :rtype: str + """ + return self._currency + + @currency.setter + def currency(self, currency): + """ + Sets the currency of this InlineResponse2011PaymentAccountInformationCard. + This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. + + :param currency: The currency of this InlineResponse2011PaymentAccountInformationCard. + :type: str + """ + + self._currency = currency + + @property + def max_length(self): + """ + Gets the max_length of this InlineResponse2011PaymentAccountInformationCard. + This field contains the max length of the card. + + :return: The max_length of this InlineResponse2011PaymentAccountInformationCard. + :rtype: str + """ + return self._max_length + + @max_length.setter + def max_length(self, max_length): + """ + Sets the max_length of this InlineResponse2011PaymentAccountInformationCard. + This field contains the max length of the card. + + :param max_length: The max_length of this InlineResponse2011PaymentAccountInformationCard. + :type: str + """ + + self._max_length = max_length + + @property + def credential_type(self): + """ + Gets the credential_type of this InlineResponse2011PaymentAccountInformationCard. + This field contains the type of the payment credential. Possible values: - PAN - TOKEN + + :return: The credential_type of this InlineResponse2011PaymentAccountInformationCard. + :rtype: str + """ + return self._credential_type + + @credential_type.setter + def credential_type(self, credential_type): + """ + Sets the credential_type of this InlineResponse2011PaymentAccountInformationCard. + This field contains the type of the payment credential. Possible values: - PAN - TOKEN + + :param credential_type: The credential_type of this InlineResponse2011PaymentAccountInformationCard. + :type: str + """ + + self._credential_type = credential_type + + @property + def brands(self): + """ + Gets the brands of this InlineResponse2011PaymentAccountInformationCard. + Array of brands + + :return: The brands of this InlineResponse2011PaymentAccountInformationCard. + :rtype: list[InlineResponse2011PaymentAccountInformationCardBrands] + """ + return self._brands + + @brands.setter + def brands(self, brands): + """ + Sets the brands of this InlineResponse2011PaymentAccountInformationCard. + Array of brands + + :param brands: The brands of this InlineResponse2011PaymentAccountInformationCard. + :type: list[InlineResponse2011PaymentAccountInformationCardBrands] + """ + + self._brands = brands + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse2011PaymentAccountInformationCard): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response2011_payment_account_information_card_brands.py b/CyberSource/models/inline_response2011_payment_account_information_card_brands.py new file mode 100644 index 00000000..9608eef3 --- /dev/null +++ b/CyberSource/models/inline_response2011_payment_account_information_card_brands.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse2011PaymentAccountInformationCardBrands(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'type': 'str', + 'brand_name': 'str' + } + + attribute_map = { + 'type': 'type', + 'brand_name': 'brandName' + } + + def __init__(self, type=None, brand_name=None): + """ + InlineResponse2011PaymentAccountInformationCardBrands - a model defined in Swagger + """ + + self._type = None + self._brand_name = None + + if type is not None: + self.type = type + if brand_name is not None: + self.brand_name = brand_name + + @property + def type(self): + """ + Gets the type of this InlineResponse2011PaymentAccountInformationCardBrands. + This field contains the 3-digit value that indicates the card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: Enroute[^1] - `015`: Lowes Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Switch/Solo - `025`: Sams Club Consumer - `026`: Sams Club Business - `027`: Nicos - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `032`: Solo - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style - `046`: J.Crew - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo[^3] - `055`: Capital One Private Label - `058`: Carnet - `059`: ValueLink - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. + + :return: The type of this InlineResponse2011PaymentAccountInformationCardBrands. + :rtype: str + """ + return self._type + + @type.setter + def type(self, type): + """ + Sets the type of this InlineResponse2011PaymentAccountInformationCardBrands. + This field contains the 3-digit value that indicates the card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: Enroute[^1] - `015`: Lowes Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Switch/Solo - `025`: Sams Club Consumer - `026`: Sams Club Business - `027`: Nicos - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `032`: Solo - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style - `046`: J.Crew - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo[^3] - `055`: Capital One Private Label - `058`: Carnet - `059`: ValueLink - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. + + :param type: The type of this InlineResponse2011PaymentAccountInformationCardBrands. + :type: str + """ + + self._type = type + + @property + def brand_name(self): + """ + Gets the brand_name of this InlineResponse2011PaymentAccountInformationCardBrands. + This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS + + :return: The brand_name of this InlineResponse2011PaymentAccountInformationCardBrands. + :rtype: str + """ + return self._brand_name + + @brand_name.setter + def brand_name(self, brand_name): + """ + Sets the brand_name of this InlineResponse2011PaymentAccountInformationCardBrands. + This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS + + :param brand_name: The brand_name of this InlineResponse2011PaymentAccountInformationCardBrands. + :type: str + """ + + self._brand_name = brand_name + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse2011PaymentAccountInformationCardBrands): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response2011_payment_account_information_features.py b/CyberSource/models/inline_response2011_payment_account_information_features.py new file mode 100644 index 00000000..2ae93847 --- /dev/null +++ b/CyberSource/models/inline_response2011_payment_account_information_features.py @@ -0,0 +1,348 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse2011PaymentAccountInformationFeatures(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'account_funding_source': 'str', + 'account_funding_source_sub_type': 'str', + 'card_product': 'str', + 'message_type': 'str', + 'acceptance_level': 'str', + 'card_platform': 'str', + 'combo_card': 'str', + 'corporate_purchase': 'bool', + 'health_card': 'bool' + } + + attribute_map = { + 'account_funding_source': 'accountFundingSource', + 'account_funding_source_sub_type': 'accountFundingSourceSubType', + 'card_product': 'cardProduct', + 'message_type': 'messageType', + 'acceptance_level': 'acceptanceLevel', + 'card_platform': 'cardPlatform', + 'combo_card': 'comboCard', + 'corporate_purchase': 'corporatePurchase', + 'health_card': 'healthCard' + } + + def __init__(self, account_funding_source=None, account_funding_source_sub_type=None, card_product=None, message_type=None, acceptance_level=None, card_platform=None, combo_card=None, corporate_purchase=None, health_card=None): + """ + InlineResponse2011PaymentAccountInformationFeatures - a model defined in Swagger + """ + + self._account_funding_source = None + self._account_funding_source_sub_type = None + self._card_product = None + self._message_type = None + self._acceptance_level = None + self._card_platform = None + self._combo_card = None + self._corporate_purchase = None + self._health_card = None + + if account_funding_source is not None: + self.account_funding_source = account_funding_source + if account_funding_source_sub_type is not None: + self.account_funding_source_sub_type = account_funding_source_sub_type + if card_product is not None: + self.card_product = card_product + if message_type is not None: + self.message_type = message_type + if acceptance_level is not None: + self.acceptance_level = acceptance_level + if card_platform is not None: + self.card_platform = card_platform + if combo_card is not None: + self.combo_card = combo_card + if corporate_purchase is not None: + self.corporate_purchase = corporate_purchase + if health_card is not None: + self.health_card = health_card + + @property + def account_funding_source(self): + """ + Gets the account_funding_source of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the account funding source. Possible values: - `CREDIT` - `DEBIT` - `PREPAID` - `DEFERRED DEBIT` - `CHARGE` + + :return: The account_funding_source of this InlineResponse2011PaymentAccountInformationFeatures. + :rtype: str + """ + return self._account_funding_source + + @account_funding_source.setter + def account_funding_source(self, account_funding_source): + """ + Sets the account_funding_source of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the account funding source. Possible values: - `CREDIT` - `DEBIT` - `PREPAID` - `DEFERRED DEBIT` - `CHARGE` + + :param account_funding_source: The account_funding_source of this InlineResponse2011PaymentAccountInformationFeatures. + :type: str + """ + + self._account_funding_source = account_funding_source + + @property + def account_funding_source_sub_type(self): + """ + Gets the account_funding_source_sub_type of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the type of prepaid card. Possible values: - `Reloadable` - `Non-reloadable` + + :return: The account_funding_source_sub_type of this InlineResponse2011PaymentAccountInformationFeatures. + :rtype: str + """ + return self._account_funding_source_sub_type + + @account_funding_source_sub_type.setter + def account_funding_source_sub_type(self, account_funding_source_sub_type): + """ + Sets the account_funding_source_sub_type of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the type of prepaid card. Possible values: - `Reloadable` - `Non-reloadable` + + :param account_funding_source_sub_type: The account_funding_source_sub_type of this InlineResponse2011PaymentAccountInformationFeatures. + :type: str + """ + + self._account_funding_source_sub_type = account_funding_source_sub_type + + @property + def card_product(self): + """ + Gets the card_product of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the type of issuer product. Example values: - Visa Classic - Visa Signature - Visa Infinite + + :return: The card_product of this InlineResponse2011PaymentAccountInformationFeatures. + :rtype: str + """ + return self._card_product + + @card_product.setter + def card_product(self, card_product): + """ + Sets the card_product of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the type of issuer product. Example values: - Visa Classic - Visa Signature - Visa Infinite + + :param card_product: The card_product of this InlineResponse2011PaymentAccountInformationFeatures. + :type: str + """ + + self._card_product = card_product + + @property + def message_type(self): + """ + Gets the message_type of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the type of BIN based authentication. Possible values: - `S`: Single Message - `D`: Dual Message + + :return: The message_type of this InlineResponse2011PaymentAccountInformationFeatures. + :rtype: str + """ + return self._message_type + + @message_type.setter + def message_type(self, message_type): + """ + Sets the message_type of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the type of BIN based authentication. Possible values: - `S`: Single Message - `D`: Dual Message + + :param message_type: The message_type of this InlineResponse2011PaymentAccountInformationFeatures. + :type: str + """ + + self._message_type = message_type + + @property + def acceptance_level(self): + """ + Gets the acceptance_level of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the acceptance level of the PAN. Possible values: - `0` : Normal - `1` : Monitor - `2` : Refuse - `3` : Not Allowed - `4` : Private - `5` : Test + + :return: The acceptance_level of this InlineResponse2011PaymentAccountInformationFeatures. + :rtype: str + """ + return self._acceptance_level + + @acceptance_level.setter + def acceptance_level(self, acceptance_level): + """ + Sets the acceptance_level of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the acceptance level of the PAN. Possible values: - `0` : Normal - `1` : Monitor - `2` : Refuse - `3` : Not Allowed - `4` : Private - `5` : Test + + :param acceptance_level: The acceptance_level of this InlineResponse2011PaymentAccountInformationFeatures. + :type: str + """ + + self._acceptance_level = acceptance_level + + @property + def card_platform(self): + """ + Gets the card_platform of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the type of card platform. Possible values: - `BUSINESS` - `CONSUMER` - `COMMERCIAL` - `GOVERNMENT` + + :return: The card_platform of this InlineResponse2011PaymentAccountInformationFeatures. + :rtype: str + """ + return self._card_platform + + @card_platform.setter + def card_platform(self, card_platform): + """ + Sets the card_platform of this InlineResponse2011PaymentAccountInformationFeatures. + This field contains the type of card platform. Possible values: - `BUSINESS` - `CONSUMER` - `COMMERCIAL` - `GOVERNMENT` + + :param card_platform: The card_platform of this InlineResponse2011PaymentAccountInformationFeatures. + :type: str + """ + + self._card_platform = card_platform + + @property + def combo_card(self): + """ + Gets the combo_card of this InlineResponse2011PaymentAccountInformationFeatures. + This field indicates the type of combo card. Possible values: - 0 (Not a combo card) - 1 (Credit and Prepaid Combo card) - 2 (Credit and Debit Combo card) + + :return: The combo_card of this InlineResponse2011PaymentAccountInformationFeatures. + :rtype: str + """ + return self._combo_card + + @combo_card.setter + def combo_card(self, combo_card): + """ + Sets the combo_card of this InlineResponse2011PaymentAccountInformationFeatures. + This field indicates the type of combo card. Possible values: - 0 (Not a combo card) - 1 (Credit and Prepaid Combo card) - 2 (Credit and Debit Combo card) + + :param combo_card: The combo_card of this InlineResponse2011PaymentAccountInformationFeatures. + :type: str + """ + + self._combo_card = combo_card + + @property + def corporate_purchase(self): + """ + Gets the corporate_purchase of this InlineResponse2011PaymentAccountInformationFeatures. + This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards. Possible values: - `true` - `false` + + :return: The corporate_purchase of this InlineResponse2011PaymentAccountInformationFeatures. + :rtype: bool + """ + return self._corporate_purchase + + @corporate_purchase.setter + def corporate_purchase(self, corporate_purchase): + """ + Sets the corporate_purchase of this InlineResponse2011PaymentAccountInformationFeatures. + This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards. Possible values: - `true` - `false` + + :param corporate_purchase: The corporate_purchase of this InlineResponse2011PaymentAccountInformationFeatures. + :type: bool + """ + + self._corporate_purchase = corporate_purchase + + @property + def health_card(self): + """ + Gets the health_card of this InlineResponse2011PaymentAccountInformationFeatures. + This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs. Possible values: - `true` - `false` + + :return: The health_card of this InlineResponse2011PaymentAccountInformationFeatures. + :rtype: bool + """ + return self._health_card + + @health_card.setter + def health_card(self, health_card): + """ + Sets the health_card of this InlineResponse2011PaymentAccountInformationFeatures. + This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs. Possible values: - `true` - `false` + + :param health_card: The health_card of this InlineResponse2011PaymentAccountInformationFeatures. + :type: bool + """ + + self._health_card = health_card + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse2011PaymentAccountInformationFeatures): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response2011_payment_account_information_network.py b/CyberSource/models/inline_response2011_payment_account_information_network.py new file mode 100644 index 00000000..45c20e11 --- /dev/null +++ b/CyberSource/models/inline_response2011_payment_account_information_network.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse2011PaymentAccountInformationNetwork(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str' + } + + attribute_map = { + 'id': 'id' + } + + def __init__(self, id=None): + """ + InlineResponse2011PaymentAccountInformationNetwork - a model defined in Swagger + """ + + self._id = None + + if id is not None: + self.id = id + + @property + def id(self): + """ + Gets the id of this InlineResponse2011PaymentAccountInformationNetwork. + This field contains a code that identifies the network. [List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code) + + :return: The id of this InlineResponse2011PaymentAccountInformationNetwork. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this InlineResponse2011PaymentAccountInformationNetwork. + This field contains a code that identifies the network. [List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code) + + :param id: The id of this InlineResponse2011PaymentAccountInformationNetwork. + :type: str + """ + + self._id = id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse2011PaymentAccountInformationNetwork): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response2011_payout_information.py b/CyberSource/models/inline_response2011_payout_information.py new file mode 100644 index 00000000..c008e437 --- /dev/null +++ b/CyberSource/models/inline_response2011_payout_information.py @@ -0,0 +1,176 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse2011PayoutInformation(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'push_funds': 'InlineResponse2011PayoutInformationPushFunds', + 'pull_funds': 'InlineResponse2011PayoutInformationPullFunds', + 'geo_restriction_indicator': 'str' + } + + attribute_map = { + 'push_funds': 'pushFunds', + 'pull_funds': 'pullFunds', + 'geo_restriction_indicator': 'geoRestrictionIndicator' + } + + def __init__(self, push_funds=None, pull_funds=None, geo_restriction_indicator=None): + """ + InlineResponse2011PayoutInformation - a model defined in Swagger + """ + + self._push_funds = None + self._pull_funds = None + self._geo_restriction_indicator = None + + if push_funds is not None: + self.push_funds = push_funds + if pull_funds is not None: + self.pull_funds = pull_funds + if geo_restriction_indicator is not None: + self.geo_restriction_indicator = geo_restriction_indicator + + @property + def push_funds(self): + """ + Gets the push_funds of this InlineResponse2011PayoutInformation. + + :return: The push_funds of this InlineResponse2011PayoutInformation. + :rtype: InlineResponse2011PayoutInformationPushFunds + """ + return self._push_funds + + @push_funds.setter + def push_funds(self, push_funds): + """ + Sets the push_funds of this InlineResponse2011PayoutInformation. + + :param push_funds: The push_funds of this InlineResponse2011PayoutInformation. + :type: InlineResponse2011PayoutInformationPushFunds + """ + + self._push_funds = push_funds + + @property + def pull_funds(self): + """ + Gets the pull_funds of this InlineResponse2011PayoutInformation. + + :return: The pull_funds of this InlineResponse2011PayoutInformation. + :rtype: InlineResponse2011PayoutInformationPullFunds + """ + return self._pull_funds + + @pull_funds.setter + def pull_funds(self, pull_funds): + """ + Sets the pull_funds of this InlineResponse2011PayoutInformation. + + :param pull_funds: The pull_funds of this InlineResponse2011PayoutInformation. + :type: InlineResponse2011PayoutInformationPullFunds + """ + + self._pull_funds = pull_funds + + @property + def geo_restriction_indicator(self): + """ + Gets the geo_restriction_indicator of this InlineResponse2011PayoutInformation. + This field indicates if the recipient issuer can accept transactions from the originator country. Possible values: - `Y` - `N` + + :return: The geo_restriction_indicator of this InlineResponse2011PayoutInformation. + :rtype: str + """ + return self._geo_restriction_indicator + + @geo_restriction_indicator.setter + def geo_restriction_indicator(self, geo_restriction_indicator): + """ + Sets the geo_restriction_indicator of this InlineResponse2011PayoutInformation. + This field indicates if the recipient issuer can accept transactions from the originator country. Possible values: - `Y` - `N` + + :param geo_restriction_indicator: The geo_restriction_indicator of this InlineResponse2011PayoutInformation. + :type: str + """ + + self._geo_restriction_indicator = geo_restriction_indicator + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse2011PayoutInformation): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response2011_payout_information_pull_funds.py b/CyberSource/models/inline_response2011_payout_information_pull_funds.py new file mode 100644 index 00000000..8fb7cf79 --- /dev/null +++ b/CyberSource/models/inline_response2011_payout_information_pull_funds.py @@ -0,0 +1,152 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse2011PayoutInformationPullFunds(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'domestic_participant': 'str', + 'cross_border_participant': 'str' + } + + attribute_map = { + 'domestic_participant': 'domesticParticipant', + 'cross_border_participant': 'crossBorderParticipant' + } + + def __init__(self, domestic_participant=None, cross_border_participant=None): + """ + InlineResponse2011PayoutInformationPullFunds - a model defined in Swagger + """ + + self._domestic_participant = None + self._cross_border_participant = None + + if domestic_participant is not None: + self.domestic_participant = domestic_participant + if cross_border_participant is not None: + self.cross_border_participant = cross_border_participant + + @property + def domestic_participant(self): + """ + Gets the domestic_participant of this InlineResponse2011PayoutInformationPullFunds. + This field indicates if domestic AFTs (pull funds) are allowed. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` + + :return: The domestic_participant of this InlineResponse2011PayoutInformationPullFunds. + :rtype: str + """ + return self._domestic_participant + + @domestic_participant.setter + def domestic_participant(self, domestic_participant): + """ + Sets the domestic_participant of this InlineResponse2011PayoutInformationPullFunds. + This field indicates if domestic AFTs (pull funds) are allowed. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` + + :param domestic_participant: The domestic_participant of this InlineResponse2011PayoutInformationPullFunds. + :type: str + """ + + self._domestic_participant = domestic_participant + + @property + def cross_border_participant(self): + """ + Gets the cross_border_participant of this InlineResponse2011PayoutInformationPullFunds. + This field indicates if cross-border AFTs (pull funds) are allowed. Note: Supported only in US for cross-border transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` + + :return: The cross_border_participant of this InlineResponse2011PayoutInformationPullFunds. + :rtype: str + """ + return self._cross_border_participant + + @cross_border_participant.setter + def cross_border_participant(self, cross_border_participant): + """ + Sets the cross_border_participant of this InlineResponse2011PayoutInformationPullFunds. + This field indicates if cross-border AFTs (pull funds) are allowed. Note: Supported only in US for cross-border transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` + + :param cross_border_participant: The cross_border_participant of this InlineResponse2011PayoutInformationPullFunds. + :type: str + """ + + self._cross_border_participant = cross_border_participant + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse2011PayoutInformationPullFunds): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response2011_payout_information_push_funds.py b/CyberSource/models/inline_response2011_payout_information_push_funds.py new file mode 100644 index 00000000..7354daa7 --- /dev/null +++ b/CyberSource/models/inline_response2011_payout_information_push_funds.py @@ -0,0 +1,488 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse2011PayoutInformationPushFunds(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'money_transfer_fast_funds_cross_border': 'str', + 'money_transfer_fast_funds_domestic': 'str', + 'money_transfer_cross_border': 'str', + 'money_transfer_domestic': 'str', + 'non_money_transfer_fast_funds_cross_border': 'str', + 'non_money_transfer_fast_funds_domestic': 'str', + 'non_money_transfer_cross_border': 'str', + 'non_money_transfer_domestic': 'str', + 'online_gambling_fast_funds_cross_border': 'str', + 'online_gambling_fast_funds_domestic': 'str', + 'online_gambling_cross_border': 'str', + 'online_gambling_domestic': 'str', + 'domestic_participant': 'str', + 'cross_border_participant': 'str' + } + + attribute_map = { + 'money_transfer_fast_funds_cross_border': 'moneyTransferFastFundsCrossBorder', + 'money_transfer_fast_funds_domestic': 'moneyTransferFastFundsDomestic', + 'money_transfer_cross_border': 'moneyTransferCrossBorder', + 'money_transfer_domestic': 'moneyTransferDomestic', + 'non_money_transfer_fast_funds_cross_border': 'nonMoneyTransferFastFundsCrossBorder', + 'non_money_transfer_fast_funds_domestic': 'nonMoneyTransferFastFundsDomestic', + 'non_money_transfer_cross_border': 'nonMoneyTransferCrossBorder', + 'non_money_transfer_domestic': 'nonMoneyTransferDomestic', + 'online_gambling_fast_funds_cross_border': 'onlineGamblingFastFundsCrossBorder', + 'online_gambling_fast_funds_domestic': 'onlineGamblingFastFundsDomestic', + 'online_gambling_cross_border': 'onlineGamblingCrossBorder', + 'online_gambling_domestic': 'onlineGamblingDomestic', + 'domestic_participant': 'domesticParticipant', + 'cross_border_participant': 'crossBorderParticipant' + } + + def __init__(self, money_transfer_fast_funds_cross_border=None, money_transfer_fast_funds_domestic=None, money_transfer_cross_border=None, money_transfer_domestic=None, non_money_transfer_fast_funds_cross_border=None, non_money_transfer_fast_funds_domestic=None, non_money_transfer_cross_border=None, non_money_transfer_domestic=None, online_gambling_fast_funds_cross_border=None, online_gambling_fast_funds_domestic=None, online_gambling_cross_border=None, online_gambling_domestic=None, domestic_participant=None, cross_border_participant=None): + """ + InlineResponse2011PayoutInformationPushFunds - a model defined in Swagger + """ + + self._money_transfer_fast_funds_cross_border = None + self._money_transfer_fast_funds_domestic = None + self._money_transfer_cross_border = None + self._money_transfer_domestic = None + self._non_money_transfer_fast_funds_cross_border = None + self._non_money_transfer_fast_funds_domestic = None + self._non_money_transfer_cross_border = None + self._non_money_transfer_domestic = None + self._online_gambling_fast_funds_cross_border = None + self._online_gambling_fast_funds_domestic = None + self._online_gambling_cross_border = None + self._online_gambling_domestic = None + self._domestic_participant = None + self._cross_border_participant = None + + if money_transfer_fast_funds_cross_border is not None: + self.money_transfer_fast_funds_cross_border = money_transfer_fast_funds_cross_border + if money_transfer_fast_funds_domestic is not None: + self.money_transfer_fast_funds_domestic = money_transfer_fast_funds_domestic + if money_transfer_cross_border is not None: + self.money_transfer_cross_border = money_transfer_cross_border + if money_transfer_domestic is not None: + self.money_transfer_domestic = money_transfer_domestic + if non_money_transfer_fast_funds_cross_border is not None: + self.non_money_transfer_fast_funds_cross_border = non_money_transfer_fast_funds_cross_border + if non_money_transfer_fast_funds_domestic is not None: + self.non_money_transfer_fast_funds_domestic = non_money_transfer_fast_funds_domestic + if non_money_transfer_cross_border is not None: + self.non_money_transfer_cross_border = non_money_transfer_cross_border + if non_money_transfer_domestic is not None: + self.non_money_transfer_domestic = non_money_transfer_domestic + if online_gambling_fast_funds_cross_border is not None: + self.online_gambling_fast_funds_cross_border = online_gambling_fast_funds_cross_border + if online_gambling_fast_funds_domestic is not None: + self.online_gambling_fast_funds_domestic = online_gambling_fast_funds_domestic + if online_gambling_cross_border is not None: + self.online_gambling_cross_border = online_gambling_cross_border + if online_gambling_domestic is not None: + self.online_gambling_domestic = online_gambling_domestic + if domestic_participant is not None: + self.domestic_participant = domestic_participant + if cross_border_participant is not None: + self.cross_border_participant = cross_border_participant + + @property + def money_transfer_fast_funds_cross_border(self): + """ + Gets the money_transfer_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :return: The money_transfer_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._money_transfer_fast_funds_cross_border + + @money_transfer_fast_funds_cross_border.setter + def money_transfer_fast_funds_cross_border(self, money_transfer_fast_funds_cross_border): + """ + Sets the money_transfer_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :param money_transfer_fast_funds_cross_border: The money_transfer_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._money_transfer_fast_funds_cross_border = money_transfer_fast_funds_cross_border + + @property + def money_transfer_fast_funds_domestic(self): + """ + Gets the money_transfer_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :return: The money_transfer_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._money_transfer_fast_funds_domestic + + @money_transfer_fast_funds_domestic.setter + def money_transfer_fast_funds_domestic(self, money_transfer_fast_funds_domestic): + """ + Sets the money_transfer_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :param money_transfer_fast_funds_domestic: The money_transfer_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._money_transfer_fast_funds_domestic = money_transfer_fast_funds_domestic + + @property + def money_transfer_cross_border(self): + """ + Gets the money_transfer_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :return: The money_transfer_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._money_transfer_cross_border + + @money_transfer_cross_border.setter + def money_transfer_cross_border(self, money_transfer_cross_border): + """ + Sets the money_transfer_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :param money_transfer_cross_border: The money_transfer_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._money_transfer_cross_border = money_transfer_cross_border + + @property + def money_transfer_domestic(self): + """ + Gets the money_transfer_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :return: The money_transfer_domestic of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._money_transfer_domestic + + @money_transfer_domestic.setter + def money_transfer_domestic(self, money_transfer_domestic): + """ + Sets the money_transfer_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :param money_transfer_domestic: The money_transfer_domestic of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._money_transfer_domestic = money_transfer_domestic + + @property + def non_money_transfer_fast_funds_cross_border(self): + """ + Gets the non_money_transfer_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border non-money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :return: The non_money_transfer_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._non_money_transfer_fast_funds_cross_border + + @non_money_transfer_fast_funds_cross_border.setter + def non_money_transfer_fast_funds_cross_border(self, non_money_transfer_fast_funds_cross_border): + """ + Sets the non_money_transfer_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border non-money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :param non_money_transfer_fast_funds_cross_border: The non_money_transfer_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._non_money_transfer_fast_funds_cross_border = non_money_transfer_fast_funds_cross_border + + @property + def non_money_transfer_fast_funds_domestic(self): + """ + Gets the non_money_transfer_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic non-money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :return: The non_money_transfer_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._non_money_transfer_fast_funds_domestic + + @non_money_transfer_fast_funds_domestic.setter + def non_money_transfer_fast_funds_domestic(self, non_money_transfer_fast_funds_domestic): + """ + Sets the non_money_transfer_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic non-money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :param non_money_transfer_fast_funds_domestic: The non_money_transfer_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._non_money_transfer_fast_funds_domestic = non_money_transfer_fast_funds_domestic + + @property + def non_money_transfer_cross_border(self): + """ + Gets the non_money_transfer_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border non-money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :return: The non_money_transfer_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._non_money_transfer_cross_border + + @non_money_transfer_cross_border.setter + def non_money_transfer_cross_border(self, non_money_transfer_cross_border): + """ + Sets the non_money_transfer_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border non-money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :param non_money_transfer_cross_border: The non_money_transfer_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._non_money_transfer_cross_border = non_money_transfer_cross_border + + @property + def non_money_transfer_domestic(self): + """ + Gets the non_money_transfer_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic non-money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :return: The non_money_transfer_domestic of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._non_money_transfer_domestic + + @non_money_transfer_domestic.setter + def non_money_transfer_domestic(self, non_money_transfer_domestic): + """ + Sets the non_money_transfer_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic non-money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :param non_money_transfer_domestic: The non_money_transfer_domestic of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._non_money_transfer_domestic = non_money_transfer_domestic + + @property + def online_gambling_fast_funds_cross_border(self): + """ + Gets the online_gambling_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border gambling OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :return: The online_gambling_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._online_gambling_fast_funds_cross_border + + @online_gambling_fast_funds_cross_border.setter + def online_gambling_fast_funds_cross_border(self, online_gambling_fast_funds_cross_border): + """ + Sets the online_gambling_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border gambling OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :param online_gambling_fast_funds_cross_border: The online_gambling_fast_funds_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._online_gambling_fast_funds_cross_border = online_gambling_fast_funds_cross_border + + @property + def online_gambling_fast_funds_domestic(self): + """ + Gets the online_gambling_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic gambling OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :return: The online_gambling_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._online_gambling_fast_funds_domestic + + @online_gambling_fast_funds_domestic.setter + def online_gambling_fast_funds_domestic(self, online_gambling_fast_funds_domestic): + """ + Sets the online_gambling_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic gambling OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` + + :param online_gambling_fast_funds_domestic: The online_gambling_fast_funds_domestic of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._online_gambling_fast_funds_domestic = online_gambling_fast_funds_domestic + + @property + def online_gambling_cross_border(self): + """ + Gets the online_gambling_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border gambling OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :return: The online_gambling_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._online_gambling_cross_border + + @online_gambling_cross_border.setter + def online_gambling_cross_border(self, online_gambling_cross_border): + """ + Sets the online_gambling_cross_border of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border gambling OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :param online_gambling_cross_border: The online_gambling_cross_border of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._online_gambling_cross_border = online_gambling_cross_border + + @property + def online_gambling_domestic(self): + """ + Gets the online_gambling_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic gambling OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :return: The online_gambling_domestic of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._online_gambling_domestic + + @online_gambling_domestic.setter + def online_gambling_domestic(self, online_gambling_domestic): + """ + Sets the online_gambling_domestic of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic gambling OCTs (push funds) are allowed. Possible values: - `Y` - `N` + + :param online_gambling_domestic: The online_gambling_domestic of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._online_gambling_domestic = online_gambling_domestic + + @property + def domestic_participant(self): + """ + Gets the domestic_participant of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic OCTs (push funds) are allowed. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` + + :return: The domestic_participant of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._domestic_participant + + @domestic_participant.setter + def domestic_participant(self, domestic_participant): + """ + Sets the domestic_participant of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if domestic OCTs (push funds) are allowed. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` + + :param domestic_participant: The domestic_participant of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._domestic_participant = domestic_participant + + @property + def cross_border_participant(self): + """ + Gets the cross_border_participant of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border OCTs (push funds) are allowed. Note: Supported only in US for cross-border transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` + + :return: The cross_border_participant of this InlineResponse2011PayoutInformationPushFunds. + :rtype: str + """ + return self._cross_border_participant + + @cross_border_participant.setter + def cross_border_participant(self, cross_border_participant): + """ + Sets the cross_border_participant of this InlineResponse2011PayoutInformationPushFunds. + This field indicates if cross-border OCTs (push funds) are allowed. Note: Supported only in US for cross-border transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` + + :param cross_border_participant: The cross_border_participant of this InlineResponse2011PayoutInformationPushFunds. + :type: str + """ + + self._cross_border_participant = cross_border_participant + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse2011PayoutInformationPushFunds): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/inline_response2012.py b/CyberSource/models/inline_response2012.py index affb4f11..5cad4a51 100644 --- a/CyberSource/models/inline_response2012.py +++ b/CyberSource/models/inline_response2012.py @@ -30,46 +30,92 @@ class InlineResponse2012(object): and the value is json key in definition. """ swagger_types = { - 'submit_time_utc': 'str', + 'id': 'str', + 'submit_time_utc': 'date', 'status': 'str', - 'client_reference_information': 'Kmsegressv2keyssymClientReferenceInformation', - 'key_information': 'InlineResponse2012KeyInformation' + 'registration_information': 'InlineResponse2012RegistrationInformation', + 'integration_information': 'InlineResponse2012IntegrationInformation', + 'organization_information': 'InlineResponse2012OrganizationInformation', + 'product_information_setups': 'list[InlineResponse2012ProductInformationSetups]', + 'message': 'str', + 'details': 'dict(str, list[object])' } attribute_map = { + 'id': 'id', 'submit_time_utc': 'submitTimeUtc', 'status': 'status', - 'client_reference_information': 'clientReferenceInformation', - 'key_information': 'keyInformation' + 'registration_information': 'registrationInformation', + 'integration_information': 'integrationInformation', + 'organization_information': 'organizationInformation', + 'product_information_setups': 'productInformationSetups', + 'message': 'message', + 'details': 'details' } - def __init__(self, submit_time_utc=None, status=None, client_reference_information=None, key_information=None): + def __init__(self, id=None, submit_time_utc=None, status=None, registration_information=None, integration_information=None, organization_information=None, product_information_setups=None, message=None, details=None): """ InlineResponse2012 - a model defined in Swagger """ + self._id = None self._submit_time_utc = None self._status = None - self._client_reference_information = None - self._key_information = None - + self._registration_information = None + self._integration_information = None + self._organization_information = None + self._product_information_setups = None + self._message = None + self._details = None + + if id is not None: + self.id = id if submit_time_utc is not None: self.submit_time_utc = submit_time_utc if status is not None: self.status = status - if client_reference_information is not None: - self.client_reference_information = client_reference_information - if key_information is not None: - self.key_information = key_information + if registration_information is not None: + self.registration_information = registration_information + if integration_information is not None: + self.integration_information = integration_information + if organization_information is not None: + self.organization_information = organization_information + if product_information_setups is not None: + self.product_information_setups = product_information_setups + if message is not None: + self.message = message + if details is not None: + self.details = details + + @property + def id(self): + """ + Gets the id of this InlineResponse2012. + + :return: The id of this InlineResponse2012. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this InlineResponse2012. + + :param id: The id of this InlineResponse2012. + :type: str + """ + + self._id = id @property def submit_time_utc(self): """ Gets the submit_time_utc of this InlineResponse2012. - 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. + 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. :return: The submit_time_utc of this InlineResponse2012. - :rtype: str + :rtype: date """ return self._submit_time_utc @@ -77,10 +123,10 @@ def submit_time_utc(self): def submit_time_utc(self, submit_time_utc): """ Sets the submit_time_utc of this InlineResponse2012. - 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. + 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. :param submit_time_utc: The submit_time_utc of this InlineResponse2012. - :type: str + :type: date """ self._submit_time_utc = submit_time_utc @@ -89,7 +135,7 @@ def submit_time_utc(self, submit_time_utc): def status(self): """ Gets the status of this InlineResponse2012. - The status of the submitted transaction. Possible values: - ACCEPTED + The status of Registration request Possible Values: - 'INITIALIZED' - 'RECEIVED' - 'PROCESSING' - 'SUCCESS' - 'FAILURE' - 'PARTIAL' :return: The status of this InlineResponse2012. :rtype: str @@ -100,55 +146,145 @@ def status(self): def status(self, status): """ Sets the status of this InlineResponse2012. - The status of the submitted transaction. Possible values: - ACCEPTED + The status of Registration request Possible Values: - 'INITIALIZED' - 'RECEIVED' - 'PROCESSING' - 'SUCCESS' - 'FAILURE' - 'PARTIAL' :param status: The status of this InlineResponse2012. :type: str """ + allowed_values = ["INITIALIZED", "RECEIVED", "PROCESSING", "SUCCESS", "FAILURE", "PARTIAL"] + if status not in allowed_values: + raise ValueError( + "Invalid value for `status` ({0}), must be one of {1}" + .format(status, allowed_values) + ) self._status = status @property - def client_reference_information(self): + def registration_information(self): """ - Gets the client_reference_information of this InlineResponse2012. + Gets the registration_information of this InlineResponse2012. - :return: The client_reference_information of this InlineResponse2012. - :rtype: Kmsegressv2keyssymClientReferenceInformation + :return: The registration_information of this InlineResponse2012. + :rtype: InlineResponse2012RegistrationInformation """ - return self._client_reference_information + return self._registration_information - @client_reference_information.setter - def client_reference_information(self, client_reference_information): + @registration_information.setter + def registration_information(self, registration_information): """ - Sets the client_reference_information of this InlineResponse2012. + Sets the registration_information of this InlineResponse2012. - :param client_reference_information: The client_reference_information of this InlineResponse2012. - :type: Kmsegressv2keyssymClientReferenceInformation + :param registration_information: The registration_information of this InlineResponse2012. + :type: InlineResponse2012RegistrationInformation + """ + + self._registration_information = registration_information + + @property + def integration_information(self): + """ + Gets the integration_information of this InlineResponse2012. + + :return: The integration_information of this InlineResponse2012. + :rtype: InlineResponse2012IntegrationInformation + """ + return self._integration_information + + @integration_information.setter + def integration_information(self, integration_information): + """ + Sets the integration_information of this InlineResponse2012. + + :param integration_information: The integration_information of this InlineResponse2012. + :type: InlineResponse2012IntegrationInformation + """ + + self._integration_information = integration_information + + @property + def organization_information(self): + """ + Gets the organization_information of this InlineResponse2012. + + :return: The organization_information of this InlineResponse2012. + :rtype: InlineResponse2012OrganizationInformation + """ + return self._organization_information + + @organization_information.setter + def organization_information(self, organization_information): + """ + Sets the organization_information of this InlineResponse2012. + + :param organization_information: The organization_information of this InlineResponse2012. + :type: InlineResponse2012OrganizationInformation + """ + + self._organization_information = organization_information + + @property + def product_information_setups(self): + """ + Gets the product_information_setups of this InlineResponse2012. + + :return: The product_information_setups of this InlineResponse2012. + :rtype: list[InlineResponse2012ProductInformationSetups] + """ + return self._product_information_setups + + @product_information_setups.setter + def product_information_setups(self, product_information_setups): + """ + Sets the product_information_setups of this InlineResponse2012. + + :param product_information_setups: The product_information_setups of this InlineResponse2012. + :type: list[InlineResponse2012ProductInformationSetups] + """ + + self._product_information_setups = product_information_setups + + @property + def message(self): + """ + Gets the message of this InlineResponse2012. + + :return: The message of this InlineResponse2012. + :rtype: str + """ + return self._message + + @message.setter + def message(self, message): + """ + Sets the message of this InlineResponse2012. + + :param message: The message of this InlineResponse2012. + :type: str """ - self._client_reference_information = client_reference_information + self._message = message @property - def key_information(self): + def details(self): """ - Gets the key_information of this InlineResponse2012. + Gets the details of this InlineResponse2012. - :return: The key_information of this InlineResponse2012. - :rtype: InlineResponse2012KeyInformation + :return: The details of this InlineResponse2012. + :rtype: dict(str, list[object]) """ - return self._key_information + return self._details - @key_information.setter - def key_information(self, key_information): + @details.setter + def details(self, details): """ - Sets the key_information of this InlineResponse2012. + Sets the details of this InlineResponse2012. - :param key_information: The key_information of this InlineResponse2012. - :type: InlineResponse2012KeyInformation + :param details: The details of this InlineResponse2012. + :type: dict(str, list[object]) """ - self._key_information = key_information + self._details = details def to_dict(self): """ diff --git a/CyberSource/models/inline_response2011_integration_information.py b/CyberSource/models/inline_response2012_integration_information.py similarity index 87% rename from CyberSource/models/inline_response2011_integration_information.py rename to CyberSource/models/inline_response2012_integration_information.py index bdf463fa..aca90eab 100644 --- a/CyberSource/models/inline_response2011_integration_information.py +++ b/CyberSource/models/inline_response2012_integration_information.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011IntegrationInformation(object): +class InlineResponse2012IntegrationInformation(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -30,7 +30,7 @@ class InlineResponse2011IntegrationInformation(object): and the value is json key in definition. """ swagger_types = { - 'tenant_configurations': 'list[InlineResponse2011IntegrationInformationTenantConfigurations]' + 'tenant_configurations': 'list[InlineResponse2012IntegrationInformationTenantConfigurations]' } attribute_map = { @@ -39,7 +39,7 @@ class InlineResponse2011IntegrationInformation(object): def __init__(self, tenant_configurations=None): """ - InlineResponse2011IntegrationInformation - a model defined in Swagger + InlineResponse2012IntegrationInformation - a model defined in Swagger """ self._tenant_configurations = None @@ -50,22 +50,22 @@ def __init__(self, tenant_configurations=None): @property def tenant_configurations(self): """ - Gets the tenant_configurations of this InlineResponse2011IntegrationInformation. + Gets the tenant_configurations of this InlineResponse2012IntegrationInformation. tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with. - :return: The tenant_configurations of this InlineResponse2011IntegrationInformation. - :rtype: list[InlineResponse2011IntegrationInformationTenantConfigurations] + :return: The tenant_configurations of this InlineResponse2012IntegrationInformation. + :rtype: list[InlineResponse2012IntegrationInformationTenantConfigurations] """ return self._tenant_configurations @tenant_configurations.setter def tenant_configurations(self, tenant_configurations): """ - Sets the tenant_configurations of this InlineResponse2011IntegrationInformation. + Sets the tenant_configurations of this InlineResponse2012IntegrationInformation. tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with. - :param tenant_configurations: The tenant_configurations of this InlineResponse2011IntegrationInformation. - :type: list[InlineResponse2011IntegrationInformationTenantConfigurations] + :param tenant_configurations: The tenant_configurations of this InlineResponse2012IntegrationInformation. + :type: list[InlineResponse2012IntegrationInformationTenantConfigurations] """ self._tenant_configurations = tenant_configurations @@ -112,7 +112,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011IntegrationInformation): + if not isinstance(other, InlineResponse2012IntegrationInformation): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_integration_information_tenant_configurations.py b/CyberSource/models/inline_response2012_integration_information_tenant_configurations.py similarity index 84% rename from CyberSource/models/inline_response2011_integration_information_tenant_configurations.py rename to CyberSource/models/inline_response2012_integration_information_tenant_configurations.py index 26265f54..868c4594 100644 --- a/CyberSource/models/inline_response2011_integration_information_tenant_configurations.py +++ b/CyberSource/models/inline_response2012_integration_information_tenant_configurations.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011IntegrationInformationTenantConfigurations(object): +class InlineResponse2012IntegrationInformationTenantConfigurations(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -45,7 +45,7 @@ class InlineResponse2011IntegrationInformationTenantConfigurations(object): def __init__(self, solution_id=None, tenant_configuration_id=None, status=None, submit_time_utc=None): """ - InlineResponse2011IntegrationInformationTenantConfigurations - a model defined in Swagger + InlineResponse2012IntegrationInformationTenantConfigurations - a model defined in Swagger """ self._solution_id = None @@ -65,10 +65,10 @@ def __init__(self, solution_id=None, tenant_configuration_id=None, status=None, @property def solution_id(self): """ - Gets the solution_id of this InlineResponse2011IntegrationInformationTenantConfigurations. + Gets the solution_id of this InlineResponse2012IntegrationInformationTenantConfigurations. The solutionId is the unique identifier for this system resource. Partner can use it to reference the specific solution through out the system. - :return: The solution_id of this InlineResponse2011IntegrationInformationTenantConfigurations. + :return: The solution_id of this InlineResponse2012IntegrationInformationTenantConfigurations. :rtype: str """ return self._solution_id @@ -76,10 +76,10 @@ def solution_id(self): @solution_id.setter def solution_id(self, solution_id): """ - Sets the solution_id of this InlineResponse2011IntegrationInformationTenantConfigurations. + Sets the solution_id of this InlineResponse2012IntegrationInformationTenantConfigurations. The solutionId is the unique identifier for this system resource. Partner can use it to reference the specific solution through out the system. - :param solution_id: The solution_id of this InlineResponse2011IntegrationInformationTenantConfigurations. + :param solution_id: The solution_id of this InlineResponse2012IntegrationInformationTenantConfigurations. :type: str """ @@ -88,10 +88,10 @@ def solution_id(self, solution_id): @property def tenant_configuration_id(self): """ - Gets the tenant_configuration_id of this InlineResponse2011IntegrationInformationTenantConfigurations. + Gets the tenant_configuration_id of this InlineResponse2012IntegrationInformationTenantConfigurations. The tenantConfigurationId is the unique identifier for this system resource. You will see various places where it must be referenced in the URI path, or when querying the hierarchy for ancestors or descendants. - :return: The tenant_configuration_id of this InlineResponse2011IntegrationInformationTenantConfigurations. + :return: The tenant_configuration_id of this InlineResponse2012IntegrationInformationTenantConfigurations. :rtype: str """ return self._tenant_configuration_id @@ -99,10 +99,10 @@ def tenant_configuration_id(self): @tenant_configuration_id.setter def tenant_configuration_id(self, tenant_configuration_id): """ - Sets the tenant_configuration_id of this InlineResponse2011IntegrationInformationTenantConfigurations. + Sets the tenant_configuration_id of this InlineResponse2012IntegrationInformationTenantConfigurations. The tenantConfigurationId is the unique identifier for this system resource. You will see various places where it must be referenced in the URI path, or when querying the hierarchy for ancestors or descendants. - :param tenant_configuration_id: The tenant_configuration_id of this InlineResponse2011IntegrationInformationTenantConfigurations. + :param tenant_configuration_id: The tenant_configuration_id of this InlineResponse2012IntegrationInformationTenantConfigurations. :type: str """ @@ -111,9 +111,9 @@ def tenant_configuration_id(self, tenant_configuration_id): @property def status(self): """ - Gets the status of this InlineResponse2011IntegrationInformationTenantConfigurations. + Gets the status of this InlineResponse2012IntegrationInformationTenantConfigurations. - :return: The status of this InlineResponse2011IntegrationInformationTenantConfigurations. + :return: The status of this InlineResponse2012IntegrationInformationTenantConfigurations. :rtype: str """ return self._status @@ -121,9 +121,9 @@ def status(self): @status.setter def status(self, status): """ - Sets the status of this InlineResponse2011IntegrationInformationTenantConfigurations. + Sets the status of this InlineResponse2012IntegrationInformationTenantConfigurations. - :param status: The status of this InlineResponse2011IntegrationInformationTenantConfigurations. + :param status: The status of this InlineResponse2012IntegrationInformationTenantConfigurations. :type: str """ allowed_values = ["LIVE", "INACTIVE", "TEST"] @@ -138,10 +138,10 @@ def status(self, status): @property def submit_time_utc(self): """ - Gets the submit_time_utc of this InlineResponse2011IntegrationInformationTenantConfigurations. + Gets the submit_time_utc of this InlineResponse2012IntegrationInformationTenantConfigurations. Time of request in UTC. - :return: The submit_time_utc of this InlineResponse2011IntegrationInformationTenantConfigurations. + :return: The submit_time_utc of this InlineResponse2012IntegrationInformationTenantConfigurations. :rtype: datetime """ return self._submit_time_utc @@ -149,10 +149,10 @@ def submit_time_utc(self): @submit_time_utc.setter def submit_time_utc(self, submit_time_utc): """ - Sets the submit_time_utc of this InlineResponse2011IntegrationInformationTenantConfigurations. + Sets the submit_time_utc of this InlineResponse2012IntegrationInformationTenantConfigurations. Time of request in UTC. - :param submit_time_utc: The submit_time_utc of this InlineResponse2011IntegrationInformationTenantConfigurations. + :param submit_time_utc: The submit_time_utc of this InlineResponse2012IntegrationInformationTenantConfigurations. :type: datetime """ @@ -200,7 +200,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011IntegrationInformationTenantConfigurations): + if not isinstance(other, InlineResponse2012IntegrationInformationTenantConfigurations): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_organization_information.py b/CyberSource/models/inline_response2012_organization_information.py similarity index 85% rename from CyberSource/models/inline_response2011_organization_information.py rename to CyberSource/models/inline_response2012_organization_information.py index 16e3b8bc..4302ff90 100644 --- a/CyberSource/models/inline_response2011_organization_information.py +++ b/CyberSource/models/inline_response2012_organization_information.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011OrganizationInformation(object): +class InlineResponse2012OrganizationInformation(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -43,7 +43,7 @@ class InlineResponse2011OrganizationInformation(object): def __init__(self, organization_id=None, parent_organization_id=None, child_organizations=None): """ - InlineResponse2011OrganizationInformation - a model defined in Swagger + InlineResponse2012OrganizationInformation - a model defined in Swagger """ self._organization_id = None @@ -60,9 +60,9 @@ def __init__(self, organization_id=None, parent_organization_id=None, child_orga @property def organization_id(self): """ - Gets the organization_id of this InlineResponse2011OrganizationInformation. + Gets the organization_id of this InlineResponse2012OrganizationInformation. - :return: The organization_id of this InlineResponse2011OrganizationInformation. + :return: The organization_id of this InlineResponse2012OrganizationInformation. :rtype: str """ return self._organization_id @@ -70,9 +70,9 @@ def organization_id(self): @organization_id.setter def organization_id(self, organization_id): """ - Sets the organization_id of this InlineResponse2011OrganizationInformation. + Sets the organization_id of this InlineResponse2012OrganizationInformation. - :param organization_id: The organization_id of this InlineResponse2011OrganizationInformation. + :param organization_id: The organization_id of this InlineResponse2012OrganizationInformation. :type: str """ @@ -81,9 +81,9 @@ def organization_id(self, organization_id): @property def parent_organization_id(self): """ - Gets the parent_organization_id of this InlineResponse2011OrganizationInformation. + Gets the parent_organization_id of this InlineResponse2012OrganizationInformation. - :return: The parent_organization_id of this InlineResponse2011OrganizationInformation. + :return: The parent_organization_id of this InlineResponse2012OrganizationInformation. :rtype: str """ return self._parent_organization_id @@ -91,9 +91,9 @@ def parent_organization_id(self): @parent_organization_id.setter def parent_organization_id(self, parent_organization_id): """ - Sets the parent_organization_id of this InlineResponse2011OrganizationInformation. + Sets the parent_organization_id of this InlineResponse2012OrganizationInformation. - :param parent_organization_id: The parent_organization_id of this InlineResponse2011OrganizationInformation. + :param parent_organization_id: The parent_organization_id of this InlineResponse2012OrganizationInformation. :type: str """ @@ -102,9 +102,9 @@ def parent_organization_id(self, parent_organization_id): @property def child_organizations(self): """ - Gets the child_organizations of this InlineResponse2011OrganizationInformation. + Gets the child_organizations of this InlineResponse2012OrganizationInformation. - :return: The child_organizations of this InlineResponse2011OrganizationInformation. + :return: The child_organizations of this InlineResponse2012OrganizationInformation. :rtype: list[str] """ return self._child_organizations @@ -112,9 +112,9 @@ def child_organizations(self): @child_organizations.setter def child_organizations(self, child_organizations): """ - Sets the child_organizations of this InlineResponse2011OrganizationInformation. + Sets the child_organizations of this InlineResponse2012OrganizationInformation. - :param child_organizations: The child_organizations of this InlineResponse2011OrganizationInformation. + :param child_organizations: The child_organizations of this InlineResponse2012OrganizationInformation. :type: list[str] """ @@ -162,7 +162,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011OrganizationInformation): + if not isinstance(other, InlineResponse2012OrganizationInformation): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_product_information_setups.py b/CyberSource/models/inline_response2012_product_information_setups.py similarity index 80% rename from CyberSource/models/inline_response2011_product_information_setups.py rename to CyberSource/models/inline_response2012_product_information_setups.py index 0583488f..3ff59848 100644 --- a/CyberSource/models/inline_response2011_product_information_setups.py +++ b/CyberSource/models/inline_response2012_product_information_setups.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011ProductInformationSetups(object): +class InlineResponse2012ProductInformationSetups(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -31,7 +31,7 @@ class InlineResponse2011ProductInformationSetups(object): """ swagger_types = { 'organization_id': 'str', - 'setups': 'InlineResponse2011Setups' + 'setups': 'InlineResponse2012Setups' } attribute_map = { @@ -41,7 +41,7 @@ class InlineResponse2011ProductInformationSetups(object): def __init__(self, organization_id=None, setups=None): """ - InlineResponse2011ProductInformationSetups - a model defined in Swagger + InlineResponse2012ProductInformationSetups - a model defined in Swagger """ self._organization_id = None @@ -55,9 +55,9 @@ def __init__(self, organization_id=None, setups=None): @property def organization_id(self): """ - Gets the organization_id of this InlineResponse2011ProductInformationSetups. + Gets the organization_id of this InlineResponse2012ProductInformationSetups. - :return: The organization_id of this InlineResponse2011ProductInformationSetups. + :return: The organization_id of this InlineResponse2012ProductInformationSetups. :rtype: str """ return self._organization_id @@ -65,9 +65,9 @@ def organization_id(self): @organization_id.setter def organization_id(self, organization_id): """ - Sets the organization_id of this InlineResponse2011ProductInformationSetups. + Sets the organization_id of this InlineResponse2012ProductInformationSetups. - :param organization_id: The organization_id of this InlineResponse2011ProductInformationSetups. + :param organization_id: The organization_id of this InlineResponse2012ProductInformationSetups. :type: str """ @@ -76,20 +76,20 @@ def organization_id(self, organization_id): @property def setups(self): """ - Gets the setups of this InlineResponse2011ProductInformationSetups. + Gets the setups of this InlineResponse2012ProductInformationSetups. - :return: The setups of this InlineResponse2011ProductInformationSetups. - :rtype: InlineResponse2011Setups + :return: The setups of this InlineResponse2012ProductInformationSetups. + :rtype: InlineResponse2012Setups """ return self._setups @setups.setter def setups(self, setups): """ - Sets the setups of this InlineResponse2011ProductInformationSetups. + Sets the setups of this InlineResponse2012ProductInformationSetups. - :param setups: The setups of this InlineResponse2011ProductInformationSetups. - :type: InlineResponse2011Setups + :param setups: The setups of this InlineResponse2012ProductInformationSetups. + :type: InlineResponse2012Setups """ self._setups = setups @@ -136,7 +136,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011ProductInformationSetups): + if not isinstance(other, InlineResponse2012ProductInformationSetups): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_registration_information.py b/CyberSource/models/inline_response2012_registration_information.py similarity index 83% rename from CyberSource/models/inline_response2011_registration_information.py rename to CyberSource/models/inline_response2012_registration_information.py index f6720534..ed425057 100644 --- a/CyberSource/models/inline_response2011_registration_information.py +++ b/CyberSource/models/inline_response2012_registration_information.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011RegistrationInformation(object): +class InlineResponse2012RegistrationInformation(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -43,7 +43,7 @@ class InlineResponse2011RegistrationInformation(object): def __init__(self, boarding_package_id=None, mode=None, sales_rep_id=None): """ - InlineResponse2011RegistrationInformation - a model defined in Swagger + InlineResponse2012RegistrationInformation - a model defined in Swagger """ self._boarding_package_id = None @@ -60,9 +60,9 @@ def __init__(self, boarding_package_id=None, mode=None, sales_rep_id=None): @property def boarding_package_id(self): """ - Gets the boarding_package_id of this InlineResponse2011RegistrationInformation. + Gets the boarding_package_id of this InlineResponse2012RegistrationInformation. - :return: The boarding_package_id of this InlineResponse2011RegistrationInformation. + :return: The boarding_package_id of this InlineResponse2012RegistrationInformation. :rtype: str """ return self._boarding_package_id @@ -70,9 +70,9 @@ def boarding_package_id(self): @boarding_package_id.setter def boarding_package_id(self, boarding_package_id): """ - Sets the boarding_package_id of this InlineResponse2011RegistrationInformation. + Sets the boarding_package_id of this InlineResponse2012RegistrationInformation. - :param boarding_package_id: The boarding_package_id of this InlineResponse2011RegistrationInformation. + :param boarding_package_id: The boarding_package_id of this InlineResponse2012RegistrationInformation. :type: str """ @@ -81,10 +81,10 @@ def boarding_package_id(self, boarding_package_id): @property def mode(self): """ - Gets the mode of this InlineResponse2011RegistrationInformation. + Gets the mode of this InlineResponse2012RegistrationInformation. In case mode is not provided the API will use COMPLETE as default Possible Values: - 'COMPLETE' - 'PARTIAL' - :return: The mode of this InlineResponse2011RegistrationInformation. + :return: The mode of this InlineResponse2012RegistrationInformation. :rtype: str """ return self._mode @@ -92,10 +92,10 @@ def mode(self): @mode.setter def mode(self, mode): """ - Sets the mode of this InlineResponse2011RegistrationInformation. + Sets the mode of this InlineResponse2012RegistrationInformation. In case mode is not provided the API will use COMPLETE as default Possible Values: - 'COMPLETE' - 'PARTIAL' - :param mode: The mode of this InlineResponse2011RegistrationInformation. + :param mode: The mode of this InlineResponse2012RegistrationInformation. :type: str """ allowed_values = ["COMPLETE", "PARTIAL"] @@ -110,9 +110,9 @@ def mode(self, mode): @property def sales_rep_id(self): """ - Gets the sales_rep_id of this InlineResponse2011RegistrationInformation. + Gets the sales_rep_id of this InlineResponse2012RegistrationInformation. - :return: The sales_rep_id of this InlineResponse2011RegistrationInformation. + :return: The sales_rep_id of this InlineResponse2012RegistrationInformation. :rtype: str """ return self._sales_rep_id @@ -120,9 +120,9 @@ def sales_rep_id(self): @sales_rep_id.setter def sales_rep_id(self, sales_rep_id): """ - Sets the sales_rep_id of this InlineResponse2011RegistrationInformation. + Sets the sales_rep_id of this InlineResponse2012RegistrationInformation. - :param sales_rep_id: The sales_rep_id of this InlineResponse2011RegistrationInformation. + :param sales_rep_id: The sales_rep_id of this InlineResponse2012RegistrationInformation. :type: str """ @@ -170,7 +170,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011RegistrationInformation): + if not isinstance(other, InlineResponse2012RegistrationInformation): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_setups.py b/CyberSource/models/inline_response2012_setups.py similarity index 72% rename from CyberSource/models/inline_response2011_setups.py rename to CyberSource/models/inline_response2012_setups.py index d92b95bb..dc028ab9 100644 --- a/CyberSource/models/inline_response2011_setups.py +++ b/CyberSource/models/inline_response2012_setups.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011Setups(object): +class InlineResponse2012Setups(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -30,10 +30,10 @@ class InlineResponse2011Setups(object): and the value is json key in definition. """ swagger_types = { - 'payments': 'InlineResponse2011SetupsPayments', - 'risk': 'InlineResponse2011SetupsRisk', - 'commerce_solutions': 'InlineResponse2011SetupsCommerceSolutions', - 'value_added_services': 'InlineResponse2011SetupsValueAddedServices' + 'payments': 'InlineResponse2012SetupsPayments', + 'risk': 'InlineResponse2012SetupsRisk', + 'commerce_solutions': 'InlineResponse2012SetupsCommerceSolutions', + 'value_added_services': 'InlineResponse2012SetupsValueAddedServices' } attribute_map = { @@ -45,7 +45,7 @@ class InlineResponse2011Setups(object): def __init__(self, payments=None, risk=None, commerce_solutions=None, value_added_services=None): """ - InlineResponse2011Setups - a model defined in Swagger + InlineResponse2012Setups - a model defined in Swagger """ self._payments = None @@ -65,20 +65,20 @@ def __init__(self, payments=None, risk=None, commerce_solutions=None, value_adde @property def payments(self): """ - Gets the payments of this InlineResponse2011Setups. + Gets the payments of this InlineResponse2012Setups. - :return: The payments of this InlineResponse2011Setups. - :rtype: InlineResponse2011SetupsPayments + :return: The payments of this InlineResponse2012Setups. + :rtype: InlineResponse2012SetupsPayments """ return self._payments @payments.setter def payments(self, payments): """ - Sets the payments of this InlineResponse2011Setups. + Sets the payments of this InlineResponse2012Setups. - :param payments: The payments of this InlineResponse2011Setups. - :type: InlineResponse2011SetupsPayments + :param payments: The payments of this InlineResponse2012Setups. + :type: InlineResponse2012SetupsPayments """ self._payments = payments @@ -86,20 +86,20 @@ def payments(self, payments): @property def risk(self): """ - Gets the risk of this InlineResponse2011Setups. + Gets the risk of this InlineResponse2012Setups. - :return: The risk of this InlineResponse2011Setups. - :rtype: InlineResponse2011SetupsRisk + :return: The risk of this InlineResponse2012Setups. + :rtype: InlineResponse2012SetupsRisk """ return self._risk @risk.setter def risk(self, risk): """ - Sets the risk of this InlineResponse2011Setups. + Sets the risk of this InlineResponse2012Setups. - :param risk: The risk of this InlineResponse2011Setups. - :type: InlineResponse2011SetupsRisk + :param risk: The risk of this InlineResponse2012Setups. + :type: InlineResponse2012SetupsRisk """ self._risk = risk @@ -107,20 +107,20 @@ def risk(self, risk): @property def commerce_solutions(self): """ - Gets the commerce_solutions of this InlineResponse2011Setups. + Gets the commerce_solutions of this InlineResponse2012Setups. - :return: The commerce_solutions of this InlineResponse2011Setups. - :rtype: InlineResponse2011SetupsCommerceSolutions + :return: The commerce_solutions of this InlineResponse2012Setups. + :rtype: InlineResponse2012SetupsCommerceSolutions """ return self._commerce_solutions @commerce_solutions.setter def commerce_solutions(self, commerce_solutions): """ - Sets the commerce_solutions of this InlineResponse2011Setups. + Sets the commerce_solutions of this InlineResponse2012Setups. - :param commerce_solutions: The commerce_solutions of this InlineResponse2011Setups. - :type: InlineResponse2011SetupsCommerceSolutions + :param commerce_solutions: The commerce_solutions of this InlineResponse2012Setups. + :type: InlineResponse2012SetupsCommerceSolutions """ self._commerce_solutions = commerce_solutions @@ -128,20 +128,20 @@ def commerce_solutions(self, commerce_solutions): @property def value_added_services(self): """ - Gets the value_added_services of this InlineResponse2011Setups. + Gets the value_added_services of this InlineResponse2012Setups. - :return: The value_added_services of this InlineResponse2011Setups. - :rtype: InlineResponse2011SetupsValueAddedServices + :return: The value_added_services of this InlineResponse2012Setups. + :rtype: InlineResponse2012SetupsValueAddedServices """ return self._value_added_services @value_added_services.setter def value_added_services(self, value_added_services): """ - Sets the value_added_services of this InlineResponse2011Setups. + Sets the value_added_services of this InlineResponse2012Setups. - :param value_added_services: The value_added_services of this InlineResponse2011Setups. - :type: InlineResponse2011SetupsValueAddedServices + :param value_added_services: The value_added_services of this InlineResponse2012Setups. + :type: InlineResponse2012SetupsValueAddedServices """ self._value_added_services = value_added_services @@ -188,7 +188,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011Setups): + if not isinstance(other, InlineResponse2012Setups): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_setups_commerce_solutions.py b/CyberSource/models/inline_response2012_setups_commerce_solutions.py similarity index 73% rename from CyberSource/models/inline_response2011_setups_commerce_solutions.py rename to CyberSource/models/inline_response2012_setups_commerce_solutions.py index 352b7d3c..023c5dd7 100644 --- a/CyberSource/models/inline_response2011_setups_commerce_solutions.py +++ b/CyberSource/models/inline_response2012_setups_commerce_solutions.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011SetupsCommerceSolutions(object): +class InlineResponse2012SetupsCommerceSolutions(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -30,9 +30,9 @@ class InlineResponse2011SetupsCommerceSolutions(object): and the value is json key in definition. """ swagger_types = { - 'token_management': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'account_updater': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'bin_lookup': 'InlineResponse2011SetupsPaymentsCardProcessing' + 'token_management': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'account_updater': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'bin_lookup': 'InlineResponse2012SetupsPaymentsCardProcessing' } attribute_map = { @@ -43,7 +43,7 @@ class InlineResponse2011SetupsCommerceSolutions(object): def __init__(self, token_management=None, account_updater=None, bin_lookup=None): """ - InlineResponse2011SetupsCommerceSolutions - a model defined in Swagger + InlineResponse2012SetupsCommerceSolutions - a model defined in Swagger """ self._token_management = None @@ -60,20 +60,20 @@ def __init__(self, token_management=None, account_updater=None, bin_lookup=None) @property def token_management(self): """ - Gets the token_management of this InlineResponse2011SetupsCommerceSolutions. + Gets the token_management of this InlineResponse2012SetupsCommerceSolutions. - :return: The token_management of this InlineResponse2011SetupsCommerceSolutions. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The token_management of this InlineResponse2012SetupsCommerceSolutions. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._token_management @token_management.setter def token_management(self, token_management): """ - Sets the token_management of this InlineResponse2011SetupsCommerceSolutions. + Sets the token_management of this InlineResponse2012SetupsCommerceSolutions. - :param token_management: The token_management of this InlineResponse2011SetupsCommerceSolutions. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param token_management: The token_management of this InlineResponse2012SetupsCommerceSolutions. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._token_management = token_management @@ -81,20 +81,20 @@ def token_management(self, token_management): @property def account_updater(self): """ - Gets the account_updater of this InlineResponse2011SetupsCommerceSolutions. + Gets the account_updater of this InlineResponse2012SetupsCommerceSolutions. - :return: The account_updater of this InlineResponse2011SetupsCommerceSolutions. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The account_updater of this InlineResponse2012SetupsCommerceSolutions. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._account_updater @account_updater.setter def account_updater(self, account_updater): """ - Sets the account_updater of this InlineResponse2011SetupsCommerceSolutions. + Sets the account_updater of this InlineResponse2012SetupsCommerceSolutions. - :param account_updater: The account_updater of this InlineResponse2011SetupsCommerceSolutions. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param account_updater: The account_updater of this InlineResponse2012SetupsCommerceSolutions. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._account_updater = account_updater @@ -102,20 +102,20 @@ def account_updater(self, account_updater): @property def bin_lookup(self): """ - Gets the bin_lookup of this InlineResponse2011SetupsCommerceSolutions. + Gets the bin_lookup of this InlineResponse2012SetupsCommerceSolutions. - :return: The bin_lookup of this InlineResponse2011SetupsCommerceSolutions. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The bin_lookup of this InlineResponse2012SetupsCommerceSolutions. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._bin_lookup @bin_lookup.setter def bin_lookup(self, bin_lookup): """ - Sets the bin_lookup of this InlineResponse2011SetupsCommerceSolutions. + Sets the bin_lookup of this InlineResponse2012SetupsCommerceSolutions. - :param bin_lookup: The bin_lookup of this InlineResponse2011SetupsCommerceSolutions. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param bin_lookup: The bin_lookup of this InlineResponse2012SetupsCommerceSolutions. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._bin_lookup = bin_lookup @@ -162,7 +162,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011SetupsCommerceSolutions): + if not isinstance(other, InlineResponse2012SetupsCommerceSolutions): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_setups_payments.py b/CyberSource/models/inline_response2012_setups_payments.py similarity index 64% rename from CyberSource/models/inline_response2011_setups_payments.py rename to CyberSource/models/inline_response2012_setups_payments.py index 452e6c74..ab04dc39 100644 --- a/CyberSource/models/inline_response2011_setups_payments.py +++ b/CyberSource/models/inline_response2012_setups_payments.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011SetupsPayments(object): +class InlineResponse2012SetupsPayments(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -30,23 +30,23 @@ class InlineResponse2011SetupsPayments(object): and the value is json key in definition. """ swagger_types = { - 'card_processing': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'card_present_connect': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'e_check': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'payer_authentication': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'digital_payments': 'InlineResponse2011SetupsPaymentsDigitalPayments', - 'secure_acceptance': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'virtual_terminal': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'currency_conversion': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'tax': 'InlineResponse2011SetupsPaymentsDigitalPayments', - 'customer_invoicing': 'InlineResponse2011SetupsPaymentsDigitalPayments', - 'recurring_billing': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'cybs_ready_terminal': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'payment_orchestration': 'InlineResponse2011SetupsPaymentsDigitalPayments', - 'payouts': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'pay_by_link': 'InlineResponse2011SetupsPaymentsDigitalPayments', - 'unified_checkout': 'InlineResponse2011SetupsPaymentsDigitalPayments', - 'receivables_manager': 'InlineResponse2011SetupsPaymentsDigitalPayments' + 'card_processing': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'card_present_connect': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'e_check': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'payer_authentication': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'digital_payments': 'InlineResponse2012SetupsPaymentsDigitalPayments', + 'secure_acceptance': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'virtual_terminal': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'currency_conversion': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'tax': 'InlineResponse2012SetupsPaymentsDigitalPayments', + 'customer_invoicing': 'InlineResponse2012SetupsPaymentsDigitalPayments', + 'recurring_billing': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'cybs_ready_terminal': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'payment_orchestration': 'InlineResponse2012SetupsPaymentsDigitalPayments', + 'payouts': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'pay_by_link': 'InlineResponse2012SetupsPaymentsDigitalPayments', + 'unified_checkout': 'InlineResponse2012SetupsPaymentsDigitalPayments', + 'receivables_manager': 'InlineResponse2012SetupsPaymentsDigitalPayments' } attribute_map = { @@ -71,7 +71,7 @@ class InlineResponse2011SetupsPayments(object): def __init__(self, card_processing=None, card_present_connect=None, e_check=None, payer_authentication=None, digital_payments=None, secure_acceptance=None, virtual_terminal=None, currency_conversion=None, tax=None, customer_invoicing=None, recurring_billing=None, cybs_ready_terminal=None, payment_orchestration=None, payouts=None, pay_by_link=None, unified_checkout=None, receivables_manager=None): """ - InlineResponse2011SetupsPayments - a model defined in Swagger + InlineResponse2012SetupsPayments - a model defined in Swagger """ self._card_processing = None @@ -130,20 +130,20 @@ def __init__(self, card_processing=None, card_present_connect=None, e_check=None @property def card_processing(self): """ - Gets the card_processing of this InlineResponse2011SetupsPayments. + Gets the card_processing of this InlineResponse2012SetupsPayments. - :return: The card_processing of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The card_processing of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._card_processing @card_processing.setter def card_processing(self, card_processing): """ - Sets the card_processing of this InlineResponse2011SetupsPayments. + Sets the card_processing of this InlineResponse2012SetupsPayments. - :param card_processing: The card_processing of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param card_processing: The card_processing of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._card_processing = card_processing @@ -151,20 +151,20 @@ def card_processing(self, card_processing): @property def card_present_connect(self): """ - Gets the card_present_connect of this InlineResponse2011SetupsPayments. + Gets the card_present_connect of this InlineResponse2012SetupsPayments. - :return: The card_present_connect of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The card_present_connect of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._card_present_connect @card_present_connect.setter def card_present_connect(self, card_present_connect): """ - Sets the card_present_connect of this InlineResponse2011SetupsPayments. + Sets the card_present_connect of this InlineResponse2012SetupsPayments. - :param card_present_connect: The card_present_connect of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param card_present_connect: The card_present_connect of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._card_present_connect = card_present_connect @@ -172,20 +172,20 @@ def card_present_connect(self, card_present_connect): @property def e_check(self): """ - Gets the e_check of this InlineResponse2011SetupsPayments. + Gets the e_check of this InlineResponse2012SetupsPayments. - :return: The e_check of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The e_check of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._e_check @e_check.setter def e_check(self, e_check): """ - Sets the e_check of this InlineResponse2011SetupsPayments. + Sets the e_check of this InlineResponse2012SetupsPayments. - :param e_check: The e_check of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param e_check: The e_check of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._e_check = e_check @@ -193,20 +193,20 @@ def e_check(self, e_check): @property def payer_authentication(self): """ - Gets the payer_authentication of this InlineResponse2011SetupsPayments. + Gets the payer_authentication of this InlineResponse2012SetupsPayments. - :return: The payer_authentication of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The payer_authentication of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._payer_authentication @payer_authentication.setter def payer_authentication(self, payer_authentication): """ - Sets the payer_authentication of this InlineResponse2011SetupsPayments. + Sets the payer_authentication of this InlineResponse2012SetupsPayments. - :param payer_authentication: The payer_authentication of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param payer_authentication: The payer_authentication of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._payer_authentication = payer_authentication @@ -214,20 +214,20 @@ def payer_authentication(self, payer_authentication): @property def digital_payments(self): """ - Gets the digital_payments of this InlineResponse2011SetupsPayments. + Gets the digital_payments of this InlineResponse2012SetupsPayments. - :return: The digital_payments of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsDigitalPayments + :return: The digital_payments of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsDigitalPayments """ return self._digital_payments @digital_payments.setter def digital_payments(self, digital_payments): """ - Sets the digital_payments of this InlineResponse2011SetupsPayments. + Sets the digital_payments of this InlineResponse2012SetupsPayments. - :param digital_payments: The digital_payments of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsDigitalPayments + :param digital_payments: The digital_payments of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsDigitalPayments """ self._digital_payments = digital_payments @@ -235,20 +235,20 @@ def digital_payments(self, digital_payments): @property def secure_acceptance(self): """ - Gets the secure_acceptance of this InlineResponse2011SetupsPayments. + Gets the secure_acceptance of this InlineResponse2012SetupsPayments. - :return: The secure_acceptance of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The secure_acceptance of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._secure_acceptance @secure_acceptance.setter def secure_acceptance(self, secure_acceptance): """ - Sets the secure_acceptance of this InlineResponse2011SetupsPayments. + Sets the secure_acceptance of this InlineResponse2012SetupsPayments. - :param secure_acceptance: The secure_acceptance of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param secure_acceptance: The secure_acceptance of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._secure_acceptance = secure_acceptance @@ -256,20 +256,20 @@ def secure_acceptance(self, secure_acceptance): @property def virtual_terminal(self): """ - Gets the virtual_terminal of this InlineResponse2011SetupsPayments. + Gets the virtual_terminal of this InlineResponse2012SetupsPayments. - :return: The virtual_terminal of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The virtual_terminal of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._virtual_terminal @virtual_terminal.setter def virtual_terminal(self, virtual_terminal): """ - Sets the virtual_terminal of this InlineResponse2011SetupsPayments. + Sets the virtual_terminal of this InlineResponse2012SetupsPayments. - :param virtual_terminal: The virtual_terminal of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param virtual_terminal: The virtual_terminal of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._virtual_terminal = virtual_terminal @@ -277,20 +277,20 @@ def virtual_terminal(self, virtual_terminal): @property def currency_conversion(self): """ - Gets the currency_conversion of this InlineResponse2011SetupsPayments. + Gets the currency_conversion of this InlineResponse2012SetupsPayments. - :return: The currency_conversion of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The currency_conversion of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._currency_conversion @currency_conversion.setter def currency_conversion(self, currency_conversion): """ - Sets the currency_conversion of this InlineResponse2011SetupsPayments. + Sets the currency_conversion of this InlineResponse2012SetupsPayments. - :param currency_conversion: The currency_conversion of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param currency_conversion: The currency_conversion of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._currency_conversion = currency_conversion @@ -298,20 +298,20 @@ def currency_conversion(self, currency_conversion): @property def tax(self): """ - Gets the tax of this InlineResponse2011SetupsPayments. + Gets the tax of this InlineResponse2012SetupsPayments. - :return: The tax of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsDigitalPayments + :return: The tax of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsDigitalPayments """ return self._tax @tax.setter def tax(self, tax): """ - Sets the tax of this InlineResponse2011SetupsPayments. + Sets the tax of this InlineResponse2012SetupsPayments. - :param tax: The tax of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsDigitalPayments + :param tax: The tax of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsDigitalPayments """ self._tax = tax @@ -319,20 +319,20 @@ def tax(self, tax): @property def customer_invoicing(self): """ - Gets the customer_invoicing of this InlineResponse2011SetupsPayments. + Gets the customer_invoicing of this InlineResponse2012SetupsPayments. - :return: The customer_invoicing of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsDigitalPayments + :return: The customer_invoicing of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsDigitalPayments """ return self._customer_invoicing @customer_invoicing.setter def customer_invoicing(self, customer_invoicing): """ - Sets the customer_invoicing of this InlineResponse2011SetupsPayments. + Sets the customer_invoicing of this InlineResponse2012SetupsPayments. - :param customer_invoicing: The customer_invoicing of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsDigitalPayments + :param customer_invoicing: The customer_invoicing of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsDigitalPayments """ self._customer_invoicing = customer_invoicing @@ -340,20 +340,20 @@ def customer_invoicing(self, customer_invoicing): @property def recurring_billing(self): """ - Gets the recurring_billing of this InlineResponse2011SetupsPayments. + Gets the recurring_billing of this InlineResponse2012SetupsPayments. - :return: The recurring_billing of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The recurring_billing of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._recurring_billing @recurring_billing.setter def recurring_billing(self, recurring_billing): """ - Sets the recurring_billing of this InlineResponse2011SetupsPayments. + Sets the recurring_billing of this InlineResponse2012SetupsPayments. - :param recurring_billing: The recurring_billing of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param recurring_billing: The recurring_billing of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._recurring_billing = recurring_billing @@ -361,20 +361,20 @@ def recurring_billing(self, recurring_billing): @property def cybs_ready_terminal(self): """ - Gets the cybs_ready_terminal of this InlineResponse2011SetupsPayments. + Gets the cybs_ready_terminal of this InlineResponse2012SetupsPayments. - :return: The cybs_ready_terminal of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The cybs_ready_terminal of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._cybs_ready_terminal @cybs_ready_terminal.setter def cybs_ready_terminal(self, cybs_ready_terminal): """ - Sets the cybs_ready_terminal of this InlineResponse2011SetupsPayments. + Sets the cybs_ready_terminal of this InlineResponse2012SetupsPayments. - :param cybs_ready_terminal: The cybs_ready_terminal of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param cybs_ready_terminal: The cybs_ready_terminal of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._cybs_ready_terminal = cybs_ready_terminal @@ -382,20 +382,20 @@ def cybs_ready_terminal(self, cybs_ready_terminal): @property def payment_orchestration(self): """ - Gets the payment_orchestration of this InlineResponse2011SetupsPayments. + Gets the payment_orchestration of this InlineResponse2012SetupsPayments. - :return: The payment_orchestration of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsDigitalPayments + :return: The payment_orchestration of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsDigitalPayments """ return self._payment_orchestration @payment_orchestration.setter def payment_orchestration(self, payment_orchestration): """ - Sets the payment_orchestration of this InlineResponse2011SetupsPayments. + Sets the payment_orchestration of this InlineResponse2012SetupsPayments. - :param payment_orchestration: The payment_orchestration of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsDigitalPayments + :param payment_orchestration: The payment_orchestration of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsDigitalPayments """ self._payment_orchestration = payment_orchestration @@ -403,20 +403,20 @@ def payment_orchestration(self, payment_orchestration): @property def payouts(self): """ - Gets the payouts of this InlineResponse2011SetupsPayments. + Gets the payouts of this InlineResponse2012SetupsPayments. - :return: The payouts of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The payouts of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._payouts @payouts.setter def payouts(self, payouts): """ - Sets the payouts of this InlineResponse2011SetupsPayments. + Sets the payouts of this InlineResponse2012SetupsPayments. - :param payouts: The payouts of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param payouts: The payouts of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._payouts = payouts @@ -424,20 +424,20 @@ def payouts(self, payouts): @property def pay_by_link(self): """ - Gets the pay_by_link of this InlineResponse2011SetupsPayments. + Gets the pay_by_link of this InlineResponse2012SetupsPayments. - :return: The pay_by_link of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsDigitalPayments + :return: The pay_by_link of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsDigitalPayments """ return self._pay_by_link @pay_by_link.setter def pay_by_link(self, pay_by_link): """ - Sets the pay_by_link of this InlineResponse2011SetupsPayments. + Sets the pay_by_link of this InlineResponse2012SetupsPayments. - :param pay_by_link: The pay_by_link of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsDigitalPayments + :param pay_by_link: The pay_by_link of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsDigitalPayments """ self._pay_by_link = pay_by_link @@ -445,20 +445,20 @@ def pay_by_link(self, pay_by_link): @property def unified_checkout(self): """ - Gets the unified_checkout of this InlineResponse2011SetupsPayments. + Gets the unified_checkout of this InlineResponse2012SetupsPayments. - :return: The unified_checkout of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsDigitalPayments + :return: The unified_checkout of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsDigitalPayments """ return self._unified_checkout @unified_checkout.setter def unified_checkout(self, unified_checkout): """ - Sets the unified_checkout of this InlineResponse2011SetupsPayments. + Sets the unified_checkout of this InlineResponse2012SetupsPayments. - :param unified_checkout: The unified_checkout of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsDigitalPayments + :param unified_checkout: The unified_checkout of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsDigitalPayments """ self._unified_checkout = unified_checkout @@ -466,20 +466,20 @@ def unified_checkout(self, unified_checkout): @property def receivables_manager(self): """ - Gets the receivables_manager of this InlineResponse2011SetupsPayments. + Gets the receivables_manager of this InlineResponse2012SetupsPayments. - :return: The receivables_manager of this InlineResponse2011SetupsPayments. - :rtype: InlineResponse2011SetupsPaymentsDigitalPayments + :return: The receivables_manager of this InlineResponse2012SetupsPayments. + :rtype: InlineResponse2012SetupsPaymentsDigitalPayments """ return self._receivables_manager @receivables_manager.setter def receivables_manager(self, receivables_manager): """ - Sets the receivables_manager of this InlineResponse2011SetupsPayments. + Sets the receivables_manager of this InlineResponse2012SetupsPayments. - :param receivables_manager: The receivables_manager of this InlineResponse2011SetupsPayments. - :type: InlineResponse2011SetupsPaymentsDigitalPayments + :param receivables_manager: The receivables_manager of this InlineResponse2012SetupsPayments. + :type: InlineResponse2012SetupsPaymentsDigitalPayments """ self._receivables_manager = receivables_manager @@ -526,7 +526,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011SetupsPayments): + if not isinstance(other, InlineResponse2012SetupsPayments): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_setups_payments_card_processing.py b/CyberSource/models/inline_response2012_setups_payments_card_processing.py similarity index 79% rename from CyberSource/models/inline_response2011_setups_payments_card_processing.py rename to CyberSource/models/inline_response2012_setups_payments_card_processing.py index 8b646435..9d7208a2 100644 --- a/CyberSource/models/inline_response2011_setups_payments_card_processing.py +++ b/CyberSource/models/inline_response2012_setups_payments_card_processing.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011SetupsPaymentsCardProcessing(object): +class InlineResponse2012SetupsPaymentsCardProcessing(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -30,8 +30,8 @@ class InlineResponse2011SetupsPaymentsCardProcessing(object): and the value is json key in definition. """ swagger_types = { - 'subscription_status': 'InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus', - 'configuration_status': 'InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus' + 'subscription_status': 'InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus', + 'configuration_status': 'InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus' } attribute_map = { @@ -41,7 +41,7 @@ class InlineResponse2011SetupsPaymentsCardProcessing(object): def __init__(self, subscription_status=None, configuration_status=None): """ - InlineResponse2011SetupsPaymentsCardProcessing - a model defined in Swagger + InlineResponse2012SetupsPaymentsCardProcessing - a model defined in Swagger """ self._subscription_status = None @@ -55,20 +55,20 @@ def __init__(self, subscription_status=None, configuration_status=None): @property def subscription_status(self): """ - Gets the subscription_status of this InlineResponse2011SetupsPaymentsCardProcessing. + Gets the subscription_status of this InlineResponse2012SetupsPaymentsCardProcessing. - :return: The subscription_status of this InlineResponse2011SetupsPaymentsCardProcessing. - :rtype: InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus + :return: The subscription_status of this InlineResponse2012SetupsPaymentsCardProcessing. + :rtype: InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus """ return self._subscription_status @subscription_status.setter def subscription_status(self, subscription_status): """ - Sets the subscription_status of this InlineResponse2011SetupsPaymentsCardProcessing. + Sets the subscription_status of this InlineResponse2012SetupsPaymentsCardProcessing. - :param subscription_status: The subscription_status of this InlineResponse2011SetupsPaymentsCardProcessing. - :type: InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus + :param subscription_status: The subscription_status of this InlineResponse2012SetupsPaymentsCardProcessing. + :type: InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus """ self._subscription_status = subscription_status @@ -76,20 +76,20 @@ def subscription_status(self, subscription_status): @property def configuration_status(self): """ - Gets the configuration_status of this InlineResponse2011SetupsPaymentsCardProcessing. + Gets the configuration_status of this InlineResponse2012SetupsPaymentsCardProcessing. - :return: The configuration_status of this InlineResponse2011SetupsPaymentsCardProcessing. - :rtype: InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus + :return: The configuration_status of this InlineResponse2012SetupsPaymentsCardProcessing. + :rtype: InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus """ return self._configuration_status @configuration_status.setter def configuration_status(self, configuration_status): """ - Sets the configuration_status of this InlineResponse2011SetupsPaymentsCardProcessing. + Sets the configuration_status of this InlineResponse2012SetupsPaymentsCardProcessing. - :param configuration_status: The configuration_status of this InlineResponse2011SetupsPaymentsCardProcessing. - :type: InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus + :param configuration_status: The configuration_status of this InlineResponse2012SetupsPaymentsCardProcessing. + :type: InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus """ self._configuration_status = configuration_status @@ -136,7 +136,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011SetupsPaymentsCardProcessing): + if not isinstance(other, InlineResponse2012SetupsPaymentsCardProcessing): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_setups_payments_card_processing_configuration_status.py b/CyberSource/models/inline_response2012_setups_payments_card_processing_configuration_status.py similarity index 79% rename from CyberSource/models/inline_response2011_setups_payments_card_processing_configuration_status.py rename to CyberSource/models/inline_response2012_setups_payments_card_processing_configuration_status.py index 456bf366..5569a459 100644 --- a/CyberSource/models/inline_response2011_setups_payments_card_processing_configuration_status.py +++ b/CyberSource/models/inline_response2012_setups_payments_card_processing_configuration_status.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus(object): +class InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -51,7 +51,7 @@ class InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus(object): def __init__(self, configuration_id=None, version=None, submit_time_utc=None, status=None, reason=None, details=None, message=None): """ - InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus - a model defined in Swagger + InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus - a model defined in Swagger """ self._configuration_id = None @@ -80,10 +80,10 @@ def __init__(self, configuration_id=None, version=None, submit_time_utc=None, st @property def configuration_id(self): """ - Gets the configuration_id of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Gets the configuration_id of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. This is NOT for MVP - :return: The configuration_id of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :return: The configuration_id of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :rtype: str """ return self._configuration_id @@ -91,10 +91,10 @@ def configuration_id(self): @configuration_id.setter def configuration_id(self, configuration_id): """ - Sets the configuration_id of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Sets the configuration_id of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. This is NOT for MVP - :param configuration_id: The configuration_id of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :param configuration_id: The configuration_id of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :type: str """ @@ -103,9 +103,9 @@ def configuration_id(self, configuration_id): @property def version(self): """ - Gets the version of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Gets the version of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. - :return: The version of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :return: The version of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :rtype: str """ return self._version @@ -113,9 +113,9 @@ def version(self): @version.setter def version(self, version): """ - Sets the version of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Sets the version of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. - :param version: The version of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :param version: The version of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :type: str """ @@ -124,10 +124,10 @@ def version(self, version): @property def submit_time_utc(self): """ - Gets the submit_time_utc of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Gets the submit_time_utc of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. 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. - :return: The submit_time_utc of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :return: The submit_time_utc of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :rtype: str """ return self._submit_time_utc @@ -135,10 +135,10 @@ def submit_time_utc(self): @submit_time_utc.setter def submit_time_utc(self, submit_time_utc): """ - Sets the submit_time_utc of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Sets the submit_time_utc of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. 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. - :param submit_time_utc: The submit_time_utc of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :param submit_time_utc: The submit_time_utc of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :type: str """ @@ -147,9 +147,9 @@ def submit_time_utc(self, submit_time_utc): @property def status(self): """ - Gets the status of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Gets the status of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. - :return: The status of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :return: The status of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :rtype: str """ return self._status @@ -157,9 +157,9 @@ def status(self): @status.setter def status(self, status): """ - Sets the status of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Sets the status of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. - :param status: The status of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :param status: The status of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :type: str """ allowed_values = ["SUCCESS", "PARTIAL", "PENDING", "NOT_SETUP"] @@ -174,9 +174,9 @@ def status(self, status): @property def reason(self): """ - Gets the reason of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Gets the reason of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. - :return: The reason of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :return: The reason of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :rtype: str """ return self._reason @@ -184,9 +184,9 @@ def reason(self): @reason.setter def reason(self, reason): """ - Sets the reason of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Sets the reason of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. - :param reason: The reason of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :param reason: The reason of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :type: str """ allowed_values = ["PENDING_PROVISIONING_PROCESS", "MISSING_DATA", "INVALID_DATA", "DUPLICATE_FIELD", "NOT_APPLICABLE"] @@ -201,9 +201,9 @@ def reason(self, reason): @property def details(self): """ - Gets the details of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Gets the details of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. - :return: The details of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :return: The details of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :rtype: list[dict(str, str)] """ return self._details @@ -211,9 +211,9 @@ def details(self): @details.setter def details(self, details): """ - Sets the details of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Sets the details of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. - :param details: The details of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :param details: The details of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :type: list[dict(str, str)] """ @@ -222,9 +222,9 @@ def details(self, details): @property def message(self): """ - Gets the message of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Gets the message of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. - :return: The message of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :return: The message of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :rtype: str """ return self._message @@ -232,9 +232,9 @@ def message(self): @message.setter def message(self, message): """ - Sets the message of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + Sets the message of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. - :param message: The message of this InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus. + :param message: The message of this InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus. :type: str """ @@ -282,7 +282,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus): + if not isinstance(other, InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_setups_payments_card_processing_subscription_status.py b/CyberSource/models/inline_response2012_setups_payments_card_processing_subscription_status.py similarity index 81% rename from CyberSource/models/inline_response2011_setups_payments_card_processing_subscription_status.py rename to CyberSource/models/inline_response2012_setups_payments_card_processing_subscription_status.py index 69b20b18..8a11e5fa 100644 --- a/CyberSource/models/inline_response2011_setups_payments_card_processing_subscription_status.py +++ b/CyberSource/models/inline_response2012_setups_payments_card_processing_subscription_status.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus(object): +class InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -47,7 +47,7 @@ class InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus(object): def __init__(self, submit_time_utc=None, status=None, reason=None, details=None, message=None): """ - InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus - a model defined in Swagger + InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus - a model defined in Swagger """ self._submit_time_utc = None @@ -70,10 +70,10 @@ def __init__(self, submit_time_utc=None, status=None, reason=None, details=None, @property def submit_time_utc(self): """ - Gets the submit_time_utc of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + Gets the submit_time_utc of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. 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. - :return: The submit_time_utc of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + :return: The submit_time_utc of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. :rtype: str """ return self._submit_time_utc @@ -81,10 +81,10 @@ def submit_time_utc(self): @submit_time_utc.setter def submit_time_utc(self, submit_time_utc): """ - Sets the submit_time_utc of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + Sets the submit_time_utc of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. 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. - :param submit_time_utc: The submit_time_utc of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + :param submit_time_utc: The submit_time_utc of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. :type: str """ @@ -93,9 +93,9 @@ def submit_time_utc(self, submit_time_utc): @property def status(self): """ - Gets the status of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + Gets the status of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. - :return: The status of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + :return: The status of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. :rtype: str """ return self._status @@ -103,9 +103,9 @@ def status(self): @status.setter def status(self, status): """ - Sets the status of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + Sets the status of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. - :param status: The status of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + :param status: The status of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. :type: str """ allowed_values = ["SUCCESS", "FAILURE", "PARTIAL", "PENDING"] @@ -120,9 +120,9 @@ def status(self, status): @property def reason(self): """ - Gets the reason of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + Gets the reason of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. - :return: The reason of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + :return: The reason of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. :rtype: str """ return self._reason @@ -130,9 +130,9 @@ def reason(self): @reason.setter def reason(self, reason): """ - Sets the reason of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + Sets the reason of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. - :param reason: The reason of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + :param reason: The reason of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. :type: str """ allowed_values = ["DEPENDENT_PRODUCT_NOT_CONTRACTED", "DEPENDENT_FEATURE_NOT_CHOSEN", "MISSING_DATA", "INVALID_DATA", "DUPLICATE_FIELD"] @@ -147,9 +147,9 @@ def reason(self, reason): @property def details(self): """ - Gets the details of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + Gets the details of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. - :return: The details of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + :return: The details of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. :rtype: list[dict(str, str)] """ return self._details @@ -157,9 +157,9 @@ def details(self): @details.setter def details(self, details): """ - Sets the details of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + Sets the details of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. - :param details: The details of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + :param details: The details of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. :type: list[dict(str, str)] """ @@ -168,9 +168,9 @@ def details(self, details): @property def message(self): """ - Gets the message of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + Gets the message of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. - :return: The message of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + :return: The message of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. :rtype: str """ return self._message @@ -178,9 +178,9 @@ def message(self): @message.setter def message(self, message): """ - Sets the message of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + Sets the message of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. - :param message: The message of this InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus. + :param message: The message of this InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus. :type: str """ @@ -228,7 +228,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus): + if not isinstance(other, InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_setups_payments_digital_payments.py b/CyberSource/models/inline_response2012_setups_payments_digital_payments.py similarity index 83% rename from CyberSource/models/inline_response2011_setups_payments_digital_payments.py rename to CyberSource/models/inline_response2012_setups_payments_digital_payments.py index 1edd89eb..01adfb57 100644 --- a/CyberSource/models/inline_response2011_setups_payments_digital_payments.py +++ b/CyberSource/models/inline_response2012_setups_payments_digital_payments.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011SetupsPaymentsDigitalPayments(object): +class InlineResponse2012SetupsPaymentsDigitalPayments(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -30,7 +30,7 @@ class InlineResponse2011SetupsPaymentsDigitalPayments(object): and the value is json key in definition. """ swagger_types = { - 'subscription_status': 'InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus' + 'subscription_status': 'InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus' } attribute_map = { @@ -39,7 +39,7 @@ class InlineResponse2011SetupsPaymentsDigitalPayments(object): def __init__(self, subscription_status=None): """ - InlineResponse2011SetupsPaymentsDigitalPayments - a model defined in Swagger + InlineResponse2012SetupsPaymentsDigitalPayments - a model defined in Swagger """ self._subscription_status = None @@ -50,20 +50,20 @@ def __init__(self, subscription_status=None): @property def subscription_status(self): """ - Gets the subscription_status of this InlineResponse2011SetupsPaymentsDigitalPayments. + Gets the subscription_status of this InlineResponse2012SetupsPaymentsDigitalPayments. - :return: The subscription_status of this InlineResponse2011SetupsPaymentsDigitalPayments. - :rtype: InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus + :return: The subscription_status of this InlineResponse2012SetupsPaymentsDigitalPayments. + :rtype: InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus """ return self._subscription_status @subscription_status.setter def subscription_status(self, subscription_status): """ - Sets the subscription_status of this InlineResponse2011SetupsPaymentsDigitalPayments. + Sets the subscription_status of this InlineResponse2012SetupsPaymentsDigitalPayments. - :param subscription_status: The subscription_status of this InlineResponse2011SetupsPaymentsDigitalPayments. - :type: InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus + :param subscription_status: The subscription_status of this InlineResponse2012SetupsPaymentsDigitalPayments. + :type: InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus """ self._subscription_status = subscription_status @@ -110,7 +110,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011SetupsPaymentsDigitalPayments): + if not isinstance(other, InlineResponse2012SetupsPaymentsDigitalPayments): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_setups_risk.py b/CyberSource/models/inline_response2012_setups_risk.py similarity index 80% rename from CyberSource/models/inline_response2011_setups_risk.py rename to CyberSource/models/inline_response2012_setups_risk.py index fb151d0a..f0a79a16 100644 --- a/CyberSource/models/inline_response2011_setups_risk.py +++ b/CyberSource/models/inline_response2012_setups_risk.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011SetupsRisk(object): +class InlineResponse2012SetupsRisk(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -30,8 +30,8 @@ class InlineResponse2011SetupsRisk(object): and the value is json key in definition. """ swagger_types = { - 'fraud_management_essentials': 'InlineResponse2011SetupsPaymentsCardProcessing', - 'decision_manager': 'InlineResponse2011SetupsPaymentsCardProcessing' + 'fraud_management_essentials': 'InlineResponse2012SetupsPaymentsCardProcessing', + 'decision_manager': 'InlineResponse2012SetupsPaymentsCardProcessing' } attribute_map = { @@ -41,7 +41,7 @@ class InlineResponse2011SetupsRisk(object): def __init__(self, fraud_management_essentials=None, decision_manager=None): """ - InlineResponse2011SetupsRisk - a model defined in Swagger + InlineResponse2012SetupsRisk - a model defined in Swagger """ self._fraud_management_essentials = None @@ -55,20 +55,20 @@ def __init__(self, fraud_management_essentials=None, decision_manager=None): @property def fraud_management_essentials(self): """ - Gets the fraud_management_essentials of this InlineResponse2011SetupsRisk. + Gets the fraud_management_essentials of this InlineResponse2012SetupsRisk. - :return: The fraud_management_essentials of this InlineResponse2011SetupsRisk. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The fraud_management_essentials of this InlineResponse2012SetupsRisk. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._fraud_management_essentials @fraud_management_essentials.setter def fraud_management_essentials(self, fraud_management_essentials): """ - Sets the fraud_management_essentials of this InlineResponse2011SetupsRisk. + Sets the fraud_management_essentials of this InlineResponse2012SetupsRisk. - :param fraud_management_essentials: The fraud_management_essentials of this InlineResponse2011SetupsRisk. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param fraud_management_essentials: The fraud_management_essentials of this InlineResponse2012SetupsRisk. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._fraud_management_essentials = fraud_management_essentials @@ -76,20 +76,20 @@ def fraud_management_essentials(self, fraud_management_essentials): @property def decision_manager(self): """ - Gets the decision_manager of this InlineResponse2011SetupsRisk. + Gets the decision_manager of this InlineResponse2012SetupsRisk. - :return: The decision_manager of this InlineResponse2011SetupsRisk. - :rtype: InlineResponse2011SetupsPaymentsCardProcessing + :return: The decision_manager of this InlineResponse2012SetupsRisk. + :rtype: InlineResponse2012SetupsPaymentsCardProcessing """ return self._decision_manager @decision_manager.setter def decision_manager(self, decision_manager): """ - Sets the decision_manager of this InlineResponse2011SetupsRisk. + Sets the decision_manager of this InlineResponse2012SetupsRisk. - :param decision_manager: The decision_manager of this InlineResponse2011SetupsRisk. - :type: InlineResponse2011SetupsPaymentsCardProcessing + :param decision_manager: The decision_manager of this InlineResponse2012SetupsRisk. + :type: InlineResponse2012SetupsPaymentsCardProcessing """ self._decision_manager = decision_manager @@ -136,7 +136,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011SetupsRisk): + if not isinstance(other, InlineResponse2012SetupsRisk): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2011_setups_value_added_services.py b/CyberSource/models/inline_response2012_setups_value_added_services.py similarity index 77% rename from CyberSource/models/inline_response2011_setups_value_added_services.py rename to CyberSource/models/inline_response2012_setups_value_added_services.py index da48f13a..091f6dea 100644 --- a/CyberSource/models/inline_response2011_setups_value_added_services.py +++ b/CyberSource/models/inline_response2012_setups_value_added_services.py @@ -15,7 +15,7 @@ import re -class InlineResponse2011SetupsValueAddedServices(object): +class InlineResponse2012SetupsValueAddedServices(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -30,8 +30,8 @@ class InlineResponse2011SetupsValueAddedServices(object): and the value is json key in definition. """ swagger_types = { - 'reporting': 'InlineResponse2011SetupsPaymentsDigitalPayments', - 'transaction_search': 'InlineResponse2011SetupsPaymentsDigitalPayments' + 'reporting': 'InlineResponse2012SetupsPaymentsDigitalPayments', + 'transaction_search': 'InlineResponse2012SetupsPaymentsDigitalPayments' } attribute_map = { @@ -41,7 +41,7 @@ class InlineResponse2011SetupsValueAddedServices(object): def __init__(self, reporting=None, transaction_search=None): """ - InlineResponse2011SetupsValueAddedServices - a model defined in Swagger + InlineResponse2012SetupsValueAddedServices - a model defined in Swagger """ self._reporting = None @@ -55,20 +55,20 @@ def __init__(self, reporting=None, transaction_search=None): @property def reporting(self): """ - Gets the reporting of this InlineResponse2011SetupsValueAddedServices. + Gets the reporting of this InlineResponse2012SetupsValueAddedServices. - :return: The reporting of this InlineResponse2011SetupsValueAddedServices. - :rtype: InlineResponse2011SetupsPaymentsDigitalPayments + :return: The reporting of this InlineResponse2012SetupsValueAddedServices. + :rtype: InlineResponse2012SetupsPaymentsDigitalPayments """ return self._reporting @reporting.setter def reporting(self, reporting): """ - Sets the reporting of this InlineResponse2011SetupsValueAddedServices. + Sets the reporting of this InlineResponse2012SetupsValueAddedServices. - :param reporting: The reporting of this InlineResponse2011SetupsValueAddedServices. - :type: InlineResponse2011SetupsPaymentsDigitalPayments + :param reporting: The reporting of this InlineResponse2012SetupsValueAddedServices. + :type: InlineResponse2012SetupsPaymentsDigitalPayments """ self._reporting = reporting @@ -76,20 +76,20 @@ def reporting(self, reporting): @property def transaction_search(self): """ - Gets the transaction_search of this InlineResponse2011SetupsValueAddedServices. + Gets the transaction_search of this InlineResponse2012SetupsValueAddedServices. - :return: The transaction_search of this InlineResponse2011SetupsValueAddedServices. - :rtype: InlineResponse2011SetupsPaymentsDigitalPayments + :return: The transaction_search of this InlineResponse2012SetupsValueAddedServices. + :rtype: InlineResponse2012SetupsPaymentsDigitalPayments """ return self._transaction_search @transaction_search.setter def transaction_search(self, transaction_search): """ - Sets the transaction_search of this InlineResponse2011SetupsValueAddedServices. + Sets the transaction_search of this InlineResponse2012SetupsValueAddedServices. - :param transaction_search: The transaction_search of this InlineResponse2011SetupsValueAddedServices. - :type: InlineResponse2011SetupsPaymentsDigitalPayments + :param transaction_search: The transaction_search of this InlineResponse2012SetupsValueAddedServices. + :type: InlineResponse2012SetupsPaymentsDigitalPayments """ self._transaction_search = transaction_search @@ -136,7 +136,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2011SetupsValueAddedServices): + if not isinstance(other, InlineResponse2012SetupsValueAddedServices): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2013.py b/CyberSource/models/inline_response2013.py index 288b436a..43ffcfc5 100644 --- a/CyberSource/models/inline_response2013.py +++ b/CyberSource/models/inline_response2013.py @@ -30,257 +30,66 @@ class InlineResponse2013(object): and the value is json key in definition. """ swagger_types = { - 'webhook_id': 'str', - 'organization_id': 'str', - 'product_id': 'str', - 'event_types': 'list[str]', - 'webhook_url': 'str', - 'health_check_url': 'str', - 'notification_scope': 'Notificationsubscriptionsv1webhooksNotificationScope', + 'submit_time_utc': 'str', 'status': 'str', - 'name': 'str', - 'description': 'str', - 'retry_policy': 'Notificationsubscriptionsv1webhooksRetryPolicy', - 'security_policy': 'Notificationsubscriptionsv1webhooksSecurityPolicy', - 'created_on': 'str', - 'updated_on': 'str', - 'additional_attributes': 'list[dict(str, str)]' + 'client_reference_information': 'Kmsegressv2keyssymClientReferenceInformation', + 'key_information': 'InlineResponse2013KeyInformation' } attribute_map = { - 'webhook_id': 'webhookId', - 'organization_id': 'organizationId', - 'product_id': 'productId', - 'event_types': 'eventTypes', - 'webhook_url': 'webhookUrl', - 'health_check_url': 'healthCheckUrl', - 'notification_scope': 'notificationScope', + 'submit_time_utc': 'submitTimeUtc', 'status': 'status', - 'name': 'name', - 'description': 'description', - 'retry_policy': 'retryPolicy', - 'security_policy': 'securityPolicy', - 'created_on': 'createdOn', - 'updated_on': 'updatedOn', - 'additional_attributes': 'additionalAttributes' + 'client_reference_information': 'clientReferenceInformation', + 'key_information': 'keyInformation' } - def __init__(self, webhook_id=None, organization_id=None, product_id=None, event_types=None, webhook_url=None, health_check_url=None, notification_scope=None, status='INACTIVE', name=None, description=None, retry_policy=None, security_policy=None, created_on=None, updated_on=None, additional_attributes=None): + def __init__(self, submit_time_utc=None, status=None, client_reference_information=None, key_information=None): """ InlineResponse2013 - a model defined in Swagger """ - self._webhook_id = None - self._organization_id = None - self._product_id = None - self._event_types = None - self._webhook_url = None - self._health_check_url = None - self._notification_scope = None + self._submit_time_utc = None self._status = None - self._name = None - self._description = None - self._retry_policy = None - self._security_policy = None - self._created_on = None - self._updated_on = None - self._additional_attributes = None - - if webhook_id is not None: - self.webhook_id = webhook_id - if organization_id is not None: - self.organization_id = organization_id - if product_id is not None: - self.product_id = product_id - if event_types is not None: - self.event_types = event_types - if webhook_url is not None: - self.webhook_url = webhook_url - if health_check_url is not None: - self.health_check_url = health_check_url - if notification_scope is not None: - self.notification_scope = notification_scope + self._client_reference_information = None + self._key_information = None + + if submit_time_utc is not None: + self.submit_time_utc = submit_time_utc if status is not None: self.status = status - if name is not None: - self.name = name - if description is not None: - self.description = description - if retry_policy is not None: - self.retry_policy = retry_policy - if security_policy is not None: - self.security_policy = security_policy - if created_on is not None: - self.created_on = created_on - if updated_on is not None: - self.updated_on = updated_on - if additional_attributes is not None: - self.additional_attributes = additional_attributes - - @property - def webhook_id(self): - """ - Gets the webhook_id of this InlineResponse2013. - Webhook Id. This is generated by the server. - - :return: The webhook_id of this InlineResponse2013. - :rtype: str - """ - return self._webhook_id - - @webhook_id.setter - def webhook_id(self, webhook_id): - """ - Sets the webhook_id of this InlineResponse2013. - Webhook Id. This is generated by the server. - - :param webhook_id: The webhook_id of this InlineResponse2013. - :type: str - """ - - self._webhook_id = webhook_id - - @property - def organization_id(self): - """ - Gets the organization_id of this InlineResponse2013. - Organization ID - - :return: The organization_id of this InlineResponse2013. - :rtype: str - """ - return self._organization_id - - @organization_id.setter - def organization_id(self, organization_id): - """ - Sets the organization_id of this InlineResponse2013. - Organization ID - - :param organization_id: The organization_id of this InlineResponse2013. - :type: str - """ - - self._organization_id = organization_id - - @property - def product_id(self): - """ - Gets the product_id of this InlineResponse2013. - The product you are receiving a webhook for. - - :return: The product_id of this InlineResponse2013. - :rtype: str - """ - return self._product_id - - @product_id.setter - def product_id(self, product_id): - """ - Sets the product_id of this InlineResponse2013. - The product you are receiving a webhook for. - - :param product_id: The product_id of this InlineResponse2013. - :type: str - """ - - self._product_id = product_id - - @property - def event_types(self): - """ - Gets the event_types of this InlineResponse2013. - Array of the different events for a given product id. - - :return: The event_types of this InlineResponse2013. - :rtype: list[str] - """ - return self._event_types - - @event_types.setter - def event_types(self, event_types): - """ - Sets the event_types of this InlineResponse2013. - Array of the different events for a given product id. - - :param event_types: The event_types of this InlineResponse2013. - :type: list[str] - """ - - self._event_types = event_types - - @property - def webhook_url(self): - """ - Gets the webhook_url of this InlineResponse2013. - The client's endpoint (URL) to receive webhooks. - - :return: The webhook_url of this InlineResponse2013. - :rtype: str - """ - return self._webhook_url - - @webhook_url.setter - def webhook_url(self, webhook_url): - """ - Sets the webhook_url of this InlineResponse2013. - The client's endpoint (URL) to receive webhooks. - - :param webhook_url: The webhook_url of this InlineResponse2013. - :type: str - """ - - self._webhook_url = webhook_url + if client_reference_information is not None: + self.client_reference_information = client_reference_information + if key_information is not None: + self.key_information = key_information @property - def health_check_url(self): + def submit_time_utc(self): """ - Gets the health_check_url of this InlineResponse2013. - The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. + Gets the submit_time_utc of this InlineResponse2013. + 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. - :return: The health_check_url of this InlineResponse2013. + :return: The submit_time_utc of this InlineResponse2013. :rtype: str """ - return self._health_check_url + return self._submit_time_utc - @health_check_url.setter - def health_check_url(self, health_check_url): + @submit_time_utc.setter + def submit_time_utc(self, submit_time_utc): """ - Sets the health_check_url of this InlineResponse2013. - The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. + Sets the submit_time_utc of this InlineResponse2013. + 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. - :param health_check_url: The health_check_url of this InlineResponse2013. + :param submit_time_utc: The submit_time_utc of this InlineResponse2013. :type: str """ - self._health_check_url = health_check_url - - @property - def notification_scope(self): - """ - Gets the notification_scope of this InlineResponse2013. - - :return: The notification_scope of this InlineResponse2013. - :rtype: Notificationsubscriptionsv1webhooksNotificationScope - """ - return self._notification_scope - - @notification_scope.setter - def notification_scope(self, notification_scope): - """ - Sets the notification_scope of this InlineResponse2013. - - :param notification_scope: The notification_scope of this InlineResponse2013. - :type: Notificationsubscriptionsv1webhooksNotificationScope - """ - - self._notification_scope = notification_scope + self._submit_time_utc = submit_time_utc @property def status(self): """ Gets the status of this InlineResponse2013. - Webhook status. + The status of the submitted transaction. Possible values: - ACCEPTED :return: The status of this InlineResponse2013. :rtype: str @@ -291,7 +100,7 @@ def status(self): def status(self, status): """ Sets the status of this InlineResponse2013. - Webhook status. + The status of the submitted transaction. Possible values: - ACCEPTED :param status: The status of this InlineResponse2013. :type: str @@ -300,161 +109,46 @@ def status(self, status): self._status = status @property - def name(self): - """ - Gets the name of this InlineResponse2013. - Client friendly webhook name. - - :return: The name of this InlineResponse2013. - :rtype: str - """ - return self._name - - @name.setter - def name(self, name): - """ - Sets the name of this InlineResponse2013. - Client friendly webhook name. - - :param name: The name of this InlineResponse2013. - :type: str - """ - - self._name = name - - @property - def description(self): - """ - Gets the description of this InlineResponse2013. - Client friendly webhook description. - - :return: The description of this InlineResponse2013. - :rtype: str - """ - return self._description - - @description.setter - def description(self, description): - """ - Sets the description of this InlineResponse2013. - Client friendly webhook description. - - :param description: The description of this InlineResponse2013. - :type: str - """ - - self._description = description - - @property - def retry_policy(self): - """ - Gets the retry_policy of this InlineResponse2013. - - :return: The retry_policy of this InlineResponse2013. - :rtype: Notificationsubscriptionsv1webhooksRetryPolicy + def client_reference_information(self): """ - return self._retry_policy + Gets the client_reference_information of this InlineResponse2013. - @retry_policy.setter - def retry_policy(self, retry_policy): + :return: The client_reference_information of this InlineResponse2013. + :rtype: Kmsegressv2keyssymClientReferenceInformation """ - Sets the retry_policy of this InlineResponse2013. + return self._client_reference_information - :param retry_policy: The retry_policy of this InlineResponse2013. - :type: Notificationsubscriptionsv1webhooksRetryPolicy + @client_reference_information.setter + def client_reference_information(self, client_reference_information): """ + Sets the client_reference_information of this InlineResponse2013. - self._retry_policy = retry_policy - - @property - def security_policy(self): - """ - Gets the security_policy of this InlineResponse2013. - - :return: The security_policy of this InlineResponse2013. - :rtype: Notificationsubscriptionsv1webhooksSecurityPolicy - """ - return self._security_policy - - @security_policy.setter - def security_policy(self, security_policy): - """ - Sets the security_policy of this InlineResponse2013. - - :param security_policy: The security_policy of this InlineResponse2013. - :type: Notificationsubscriptionsv1webhooksSecurityPolicy - """ - - self._security_policy = security_policy - - @property - def created_on(self): - """ - Gets the created_on of this InlineResponse2013. - Date on which webhook was created/registered. - - :return: The created_on of this InlineResponse2013. - :rtype: str - """ - return self._created_on - - @created_on.setter - def created_on(self, created_on): - """ - Sets the created_on of this InlineResponse2013. - Date on which webhook was created/registered. - - :param created_on: The created_on of this InlineResponse2013. - :type: str - """ - - self._created_on = created_on - - @property - def updated_on(self): - """ - Gets the updated_on of this InlineResponse2013. - Date on which webhook was most recently updated. - - :return: The updated_on of this InlineResponse2013. - :rtype: str - """ - return self._updated_on - - @updated_on.setter - def updated_on(self, updated_on): - """ - Sets the updated_on of this InlineResponse2013. - Date on which webhook was most recently updated. - - :param updated_on: The updated_on of this InlineResponse2013. - :type: str + :param client_reference_information: The client_reference_information of this InlineResponse2013. + :type: Kmsegressv2keyssymClientReferenceInformation """ - self._updated_on = updated_on + self._client_reference_information = client_reference_information @property - def additional_attributes(self): + def key_information(self): """ - Gets the additional_attributes of this InlineResponse2013. - Additional, free form configuration data. + Gets the key_information of this InlineResponse2013. - :return: The additional_attributes of this InlineResponse2013. - :rtype: list[dict(str, str)] + :return: The key_information of this InlineResponse2013. + :rtype: InlineResponse2013KeyInformation """ - return self._additional_attributes + return self._key_information - @additional_attributes.setter - def additional_attributes(self, additional_attributes): + @key_information.setter + def key_information(self, key_information): """ - Sets the additional_attributes of this InlineResponse2013. - Additional, free form configuration data. + Sets the key_information of this InlineResponse2013. - :param additional_attributes: The additional_attributes of this InlineResponse2013. - :type: list[dict(str, str)] + :param key_information: The key_information of this InlineResponse2013. + :type: InlineResponse2013KeyInformation """ - self._additional_attributes = additional_attributes + self._key_information = key_information def to_dict(self): """ diff --git a/CyberSource/models/inline_response2012_key_information.py b/CyberSource/models/inline_response2013_key_information.py similarity index 74% rename from CyberSource/models/inline_response2012_key_information.py rename to CyberSource/models/inline_response2013_key_information.py index f9fad8fb..053d3bc9 100644 --- a/CyberSource/models/inline_response2012_key_information.py +++ b/CyberSource/models/inline_response2013_key_information.py @@ -15,7 +15,7 @@ import re -class InlineResponse2012KeyInformation(object): +class InlineResponse2013KeyInformation(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -40,7 +40,7 @@ class InlineResponse2012KeyInformation(object): 'status': 'str', 'expiration_date': 'str', 'message': 'str', - 'error_information': 'InlineResponse2012KeyInformationErrorInformation' + 'error_information': 'InlineResponse2013KeyInformationErrorInformation' } attribute_map = { @@ -59,7 +59,7 @@ class InlineResponse2012KeyInformation(object): def __init__(self, provider=None, tenant=None, organization_id=None, client_key_id=None, key_id=None, key=None, key_type=None, status=None, expiration_date=None, message=None, error_information=None): """ - InlineResponse2012KeyInformation - a model defined in Swagger + InlineResponse2013KeyInformation - a model defined in Swagger """ self._provider = None @@ -100,10 +100,10 @@ def __init__(self, provider=None, tenant=None, organization_id=None, client_key_ @property def provider(self): """ - Gets the provider of this InlineResponse2012KeyInformation. + Gets the provider of this InlineResponse2013KeyInformation. Provider name - :return: The provider of this InlineResponse2012KeyInformation. + :return: The provider of this InlineResponse2013KeyInformation. :rtype: str """ return self._provider @@ -111,10 +111,10 @@ def provider(self): @provider.setter def provider(self, provider): """ - Sets the provider of this InlineResponse2012KeyInformation. + Sets the provider of this InlineResponse2013KeyInformation. Provider name - :param provider: The provider of this InlineResponse2012KeyInformation. + :param provider: The provider of this InlineResponse2013KeyInformation. :type: str """ @@ -123,10 +123,10 @@ def provider(self, provider): @property def tenant(self): """ - Gets the tenant of this InlineResponse2012KeyInformation. + Gets the tenant of this InlineResponse2013KeyInformation. Tenant name - :return: The tenant of this InlineResponse2012KeyInformation. + :return: The tenant of this InlineResponse2013KeyInformation. :rtype: str """ return self._tenant @@ -134,10 +134,10 @@ def tenant(self): @tenant.setter def tenant(self, tenant): """ - Sets the tenant of this InlineResponse2012KeyInformation. + Sets the tenant of this InlineResponse2013KeyInformation. Tenant name - :param tenant: The tenant of this InlineResponse2012KeyInformation. + :param tenant: The tenant of this InlineResponse2013KeyInformation. :type: str """ @@ -146,10 +146,10 @@ def tenant(self, tenant): @property def organization_id(self): """ - Gets the organization_id of this InlineResponse2012KeyInformation. + Gets the organization_id of this InlineResponse2013KeyInformation. Organization Id - :return: The organization_id of this InlineResponse2012KeyInformation. + :return: The organization_id of this InlineResponse2013KeyInformation. :rtype: str """ return self._organization_id @@ -157,10 +157,10 @@ def organization_id(self): @organization_id.setter def organization_id(self, organization_id): """ - Sets the organization_id of this InlineResponse2012KeyInformation. + Sets the organization_id of this InlineResponse2013KeyInformation. Organization Id - :param organization_id: The organization_id of this InlineResponse2012KeyInformation. + :param organization_id: The organization_id of this InlineResponse2013KeyInformation. :type: str """ @@ -169,10 +169,10 @@ def organization_id(self, organization_id): @property def client_key_id(self): """ - Gets the client_key_id of this InlineResponse2012KeyInformation. + Gets the client_key_id of this InlineResponse2013KeyInformation. Client key Id - :return: The client_key_id of this InlineResponse2012KeyInformation. + :return: The client_key_id of this InlineResponse2013KeyInformation. :rtype: str """ return self._client_key_id @@ -180,10 +180,10 @@ def client_key_id(self): @client_key_id.setter def client_key_id(self, client_key_id): """ - Sets the client_key_id of this InlineResponse2012KeyInformation. + Sets the client_key_id of this InlineResponse2013KeyInformation. Client key Id - :param client_key_id: The client_key_id of this InlineResponse2012KeyInformation. + :param client_key_id: The client_key_id of this InlineResponse2013KeyInformation. :type: str """ @@ -192,10 +192,10 @@ def client_key_id(self, client_key_id): @property def key_id(self): """ - Gets the key_id of this InlineResponse2012KeyInformation. + Gets the key_id of this InlineResponse2013KeyInformation. Key Serial Number - :return: The key_id of this InlineResponse2012KeyInformation. + :return: The key_id of this InlineResponse2013KeyInformation. :rtype: str """ return self._key_id @@ -203,10 +203,10 @@ def key_id(self): @key_id.setter def key_id(self, key_id): """ - Sets the key_id of this InlineResponse2012KeyInformation. + Sets the key_id of this InlineResponse2013KeyInformation. Key Serial Number - :param key_id: The key_id of this InlineResponse2012KeyInformation. + :param key_id: The key_id of this InlineResponse2013KeyInformation. :type: str """ @@ -215,10 +215,10 @@ def key_id(self, key_id): @property def key(self): """ - Gets the key of this InlineResponse2012KeyInformation. + Gets the key of this InlineResponse2013KeyInformation. Value of the key - :return: The key of this InlineResponse2012KeyInformation. + :return: The key of this InlineResponse2013KeyInformation. :rtype: str """ return self._key @@ -226,10 +226,10 @@ def key(self): @key.setter def key(self, key): """ - Sets the key of this InlineResponse2012KeyInformation. + Sets the key of this InlineResponse2013KeyInformation. Value of the key - :param key: The key of this InlineResponse2012KeyInformation. + :param key: The key of this InlineResponse2013KeyInformation. :type: str """ @@ -238,10 +238,10 @@ def key(self, key): @property def key_type(self): """ - Gets the key_type of this InlineResponse2012KeyInformation. + Gets the key_type of this InlineResponse2013KeyInformation. Type of the key - :return: The key_type of this InlineResponse2012KeyInformation. + :return: The key_type of this InlineResponse2013KeyInformation. :rtype: str """ return self._key_type @@ -249,10 +249,10 @@ def key_type(self): @key_type.setter def key_type(self, key_type): """ - Sets the key_type of this InlineResponse2012KeyInformation. + Sets the key_type of this InlineResponse2013KeyInformation. Type of the key - :param key_type: The key_type of this InlineResponse2012KeyInformation. + :param key_type: The key_type of this InlineResponse2013KeyInformation. :type: str """ @@ -261,10 +261,10 @@ def key_type(self, key_type): @property def status(self): """ - Gets the status of this InlineResponse2012KeyInformation. + Gets the status of this InlineResponse2013KeyInformation. The status of the key - :return: The status of this InlineResponse2012KeyInformation. + :return: The status of this InlineResponse2013KeyInformation. :rtype: str """ return self._status @@ -272,10 +272,10 @@ def status(self): @status.setter def status(self, status): """ - Sets the status of this InlineResponse2012KeyInformation. + Sets the status of this InlineResponse2013KeyInformation. The status of the key - :param status: The status of this InlineResponse2012KeyInformation. + :param status: The status of this InlineResponse2013KeyInformation. :type: str """ @@ -284,10 +284,10 @@ def status(self, status): @property def expiration_date(self): """ - Gets the expiration_date of this InlineResponse2012KeyInformation. + Gets the expiration_date of this InlineResponse2013KeyInformation. The expiration time 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. - :return: The expiration_date of this InlineResponse2012KeyInformation. + :return: The expiration_date of this InlineResponse2013KeyInformation. :rtype: str """ return self._expiration_date @@ -295,10 +295,10 @@ def expiration_date(self): @expiration_date.setter def expiration_date(self, expiration_date): """ - Sets the expiration_date of this InlineResponse2012KeyInformation. + Sets the expiration_date of this InlineResponse2013KeyInformation. The expiration time 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. - :param expiration_date: The expiration_date of this InlineResponse2012KeyInformation. + :param expiration_date: The expiration_date of this InlineResponse2013KeyInformation. :type: str """ @@ -307,10 +307,10 @@ def expiration_date(self, expiration_date): @property def message(self): """ - Gets the message of this InlineResponse2012KeyInformation. + Gets the message of this InlineResponse2013KeyInformation. Message in case of failed key - :return: The message of this InlineResponse2012KeyInformation. + :return: The message of this InlineResponse2013KeyInformation. :rtype: str """ return self._message @@ -318,10 +318,10 @@ def message(self): @message.setter def message(self, message): """ - Sets the message of this InlineResponse2012KeyInformation. + Sets the message of this InlineResponse2013KeyInformation. Message in case of failed key - :param message: The message of this InlineResponse2012KeyInformation. + :param message: The message of this InlineResponse2013KeyInformation. :type: str """ @@ -330,20 +330,20 @@ def message(self, message): @property def error_information(self): """ - Gets the error_information of this InlineResponse2012KeyInformation. + Gets the error_information of this InlineResponse2013KeyInformation. - :return: The error_information of this InlineResponse2012KeyInformation. - :rtype: InlineResponse2012KeyInformationErrorInformation + :return: The error_information of this InlineResponse2013KeyInformation. + :rtype: InlineResponse2013KeyInformationErrorInformation """ return self._error_information @error_information.setter def error_information(self, error_information): """ - Sets the error_information of this InlineResponse2012KeyInformation. + Sets the error_information of this InlineResponse2013KeyInformation. - :param error_information: The error_information of this InlineResponse2012KeyInformation. - :type: InlineResponse2012KeyInformationErrorInformation + :param error_information: The error_information of this InlineResponse2013KeyInformation. + :type: InlineResponse2013KeyInformationErrorInformation """ self._error_information = error_information @@ -390,7 +390,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2012KeyInformation): + if not isinstance(other, InlineResponse2013KeyInformation): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2012_key_information_error_information.py b/CyberSource/models/inline_response2013_key_information_error_information.py similarity index 79% rename from CyberSource/models/inline_response2012_key_information_error_information.py rename to CyberSource/models/inline_response2013_key_information_error_information.py index 6d6bba57..cebf232e 100644 --- a/CyberSource/models/inline_response2012_key_information_error_information.py +++ b/CyberSource/models/inline_response2013_key_information_error_information.py @@ -15,7 +15,7 @@ import re -class InlineResponse2012KeyInformationErrorInformation(object): +class InlineResponse2013KeyInformationErrorInformation(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -31,7 +31,7 @@ class InlineResponse2012KeyInformationErrorInformation(object): """ swagger_types = { 'reason': 'str', - 'details': 'list[InlineResponse2012KeyInformationErrorInformationDetails]' + 'details': 'list[InlineResponse2013KeyInformationErrorInformationDetails]' } attribute_map = { @@ -41,7 +41,7 @@ class InlineResponse2012KeyInformationErrorInformation(object): def __init__(self, reason=None, details=None): """ - InlineResponse2012KeyInformationErrorInformation - a model defined in Swagger + InlineResponse2013KeyInformationErrorInformation - a model defined in Swagger """ self._reason = None @@ -55,10 +55,10 @@ def __init__(self, reason=None, details=None): @property def reason(self): """ - Gets the reason of this InlineResponse2012KeyInformationErrorInformation. + Gets the reason of this InlineResponse2013KeyInformationErrorInformation. The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - :return: The reason of this InlineResponse2012KeyInformationErrorInformation. + :return: The reason of this InlineResponse2013KeyInformationErrorInformation. :rtype: str """ return self._reason @@ -66,10 +66,10 @@ def reason(self): @reason.setter def reason(self, reason): """ - Sets the reason of this InlineResponse2012KeyInformationErrorInformation. + Sets the reason of this InlineResponse2013KeyInformationErrorInformation. The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - :param reason: The reason of this InlineResponse2012KeyInformationErrorInformation. + :param reason: The reason of this InlineResponse2013KeyInformationErrorInformation. :type: str """ @@ -78,20 +78,20 @@ def reason(self, reason): @property def details(self): """ - Gets the details of this InlineResponse2012KeyInformationErrorInformation. + Gets the details of this InlineResponse2013KeyInformationErrorInformation. - :return: The details of this InlineResponse2012KeyInformationErrorInformation. - :rtype: list[InlineResponse2012KeyInformationErrorInformationDetails] + :return: The details of this InlineResponse2013KeyInformationErrorInformation. + :rtype: list[InlineResponse2013KeyInformationErrorInformationDetails] """ return self._details @details.setter def details(self, details): """ - Sets the details of this InlineResponse2012KeyInformationErrorInformation. + Sets the details of this InlineResponse2013KeyInformationErrorInformation. - :param details: The details of this InlineResponse2012KeyInformationErrorInformation. - :type: list[InlineResponse2012KeyInformationErrorInformationDetails] + :param details: The details of this InlineResponse2013KeyInformationErrorInformation. + :type: list[InlineResponse2013KeyInformationErrorInformationDetails] """ self._details = details @@ -138,7 +138,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2012KeyInformationErrorInformation): + if not isinstance(other, InlineResponse2013KeyInformationErrorInformation): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2012_key_information_error_information_details.py b/CyberSource/models/inline_response2013_key_information_error_information_details.py similarity index 83% rename from CyberSource/models/inline_response2012_key_information_error_information_details.py rename to CyberSource/models/inline_response2013_key_information_error_information_details.py index 10482e1c..81376c50 100644 --- a/CyberSource/models/inline_response2012_key_information_error_information_details.py +++ b/CyberSource/models/inline_response2013_key_information_error_information_details.py @@ -15,7 +15,7 @@ import re -class InlineResponse2012KeyInformationErrorInformationDetails(object): +class InlineResponse2013KeyInformationErrorInformationDetails(object): """ NOTE: This class is auto generated by the swagger code generator program. Do not edit the class manually. @@ -41,7 +41,7 @@ class InlineResponse2012KeyInformationErrorInformationDetails(object): def __init__(self, field=None, reason=None): """ - InlineResponse2012KeyInformationErrorInformationDetails - a model defined in Swagger + InlineResponse2013KeyInformationErrorInformationDetails - a model defined in Swagger """ self._field = None @@ -55,10 +55,10 @@ def __init__(self, field=None, reason=None): @property def field(self): """ - Gets the field of this InlineResponse2012KeyInformationErrorInformationDetails. + Gets the field of this InlineResponse2013KeyInformationErrorInformationDetails. This is the flattened JSON object field name/path that is either missing or invalid - :return: The field of this InlineResponse2012KeyInformationErrorInformationDetails. + :return: The field of this InlineResponse2013KeyInformationErrorInformationDetails. :rtype: str """ return self._field @@ -66,10 +66,10 @@ def field(self): @field.setter def field(self, field): """ - Sets the field of this InlineResponse2012KeyInformationErrorInformationDetails. + Sets the field of this InlineResponse2013KeyInformationErrorInformationDetails. This is the flattened JSON object field name/path that is either missing or invalid - :param field: The field of this InlineResponse2012KeyInformationErrorInformationDetails. + :param field: The field of this InlineResponse2013KeyInformationErrorInformationDetails. :type: str """ @@ -78,10 +78,10 @@ def field(self, field): @property def reason(self): """ - Gets the reason of this InlineResponse2012KeyInformationErrorInformationDetails. + Gets the reason of this InlineResponse2013KeyInformationErrorInformationDetails. Possible reasons for the error. Possible values: - MISSING_FIELD - INVALID_DATA - :return: The reason of this InlineResponse2012KeyInformationErrorInformationDetails. + :return: The reason of this InlineResponse2013KeyInformationErrorInformationDetails. :rtype: str """ return self._reason @@ -89,10 +89,10 @@ def reason(self): @reason.setter def reason(self, reason): """ - Sets the reason of this InlineResponse2012KeyInformationErrorInformationDetails. + Sets the reason of this InlineResponse2013KeyInformationErrorInformationDetails. Possible reasons for the error. Possible values: - MISSING_FIELD - INVALID_DATA - :param reason: The reason of this InlineResponse2012KeyInformationErrorInformationDetails. + :param reason: The reason of this InlineResponse2013KeyInformationErrorInformationDetails. :type: str """ @@ -140,7 +140,7 @@ def __eq__(self, other): """ Returns true if both objects are equal """ - if not isinstance(other, InlineResponse2012KeyInformationErrorInformationDetails): + if not isinstance(other, InlineResponse2013KeyInformationErrorInformationDetails): return False return self.__dict__ == other.__dict__ diff --git a/CyberSource/models/inline_response2014.py b/CyberSource/models/inline_response2014.py index 724c889e..fe2297b8 100644 --- a/CyberSource/models/inline_response2014.py +++ b/CyberSource/models/inline_response2014.py @@ -30,66 +30,257 @@ class InlineResponse2014(object): and the value is json key in definition. """ swagger_types = { - 'submit_time_utc': 'str', + 'webhook_id': 'str', + 'organization_id': 'str', + 'product_id': 'str', + 'event_types': 'list[str]', + 'webhook_url': 'str', + 'health_check_url': 'str', + 'notification_scope': 'Notificationsubscriptionsv1webhooksNotificationScope', 'status': 'str', - 'client_reference_information': 'Kmsegressv2keyssymClientReferenceInformation', - 'key_information': 'Kmsegressv2keysasymKeyInformation' + 'name': 'str', + 'description': 'str', + 'retry_policy': 'Notificationsubscriptionsv1webhooksRetryPolicy', + 'security_policy': 'Notificationsubscriptionsv1webhooksSecurityPolicy', + 'created_on': 'str', + 'updated_on': 'str', + 'additional_attributes': 'list[dict(str, str)]' } attribute_map = { - 'submit_time_utc': 'submitTimeUtc', + 'webhook_id': 'webhookId', + 'organization_id': 'organizationId', + 'product_id': 'productId', + 'event_types': 'eventTypes', + 'webhook_url': 'webhookUrl', + 'health_check_url': 'healthCheckUrl', + 'notification_scope': 'notificationScope', 'status': 'status', - 'client_reference_information': 'clientReferenceInformation', - 'key_information': 'keyInformation' + 'name': 'name', + 'description': 'description', + 'retry_policy': 'retryPolicy', + 'security_policy': 'securityPolicy', + 'created_on': 'createdOn', + 'updated_on': 'updatedOn', + 'additional_attributes': 'additionalAttributes' } - def __init__(self, submit_time_utc=None, status=None, client_reference_information=None, key_information=None): + def __init__(self, webhook_id=None, organization_id=None, product_id=None, event_types=None, webhook_url=None, health_check_url=None, notification_scope=None, status='INACTIVE', name=None, description=None, retry_policy=None, security_policy=None, created_on=None, updated_on=None, additional_attributes=None): """ InlineResponse2014 - a model defined in Swagger """ - self._submit_time_utc = None + self._webhook_id = None + self._organization_id = None + self._product_id = None + self._event_types = None + self._webhook_url = None + self._health_check_url = None + self._notification_scope = None self._status = None - self._client_reference_information = None - self._key_information = None - - if submit_time_utc is not None: - self.submit_time_utc = submit_time_utc + self._name = None + self._description = None + self._retry_policy = None + self._security_policy = None + self._created_on = None + self._updated_on = None + self._additional_attributes = None + + if webhook_id is not None: + self.webhook_id = webhook_id + if organization_id is not None: + self.organization_id = organization_id + if product_id is not None: + self.product_id = product_id + if event_types is not None: + self.event_types = event_types + if webhook_url is not None: + self.webhook_url = webhook_url + if health_check_url is not None: + self.health_check_url = health_check_url + if notification_scope is not None: + self.notification_scope = notification_scope if status is not None: self.status = status - if client_reference_information is not None: - self.client_reference_information = client_reference_information - if key_information is not None: - self.key_information = key_information + if name is not None: + self.name = name + if description is not None: + self.description = description + if retry_policy is not None: + self.retry_policy = retry_policy + if security_policy is not None: + self.security_policy = security_policy + if created_on is not None: + self.created_on = created_on + if updated_on is not None: + self.updated_on = updated_on + if additional_attributes is not None: + self.additional_attributes = additional_attributes + + @property + def webhook_id(self): + """ + Gets the webhook_id of this InlineResponse2014. + Webhook Id. This is generated by the server. + + :return: The webhook_id of this InlineResponse2014. + :rtype: str + """ + return self._webhook_id + + @webhook_id.setter + def webhook_id(self, webhook_id): + """ + Sets the webhook_id of this InlineResponse2014. + Webhook Id. This is generated by the server. + + :param webhook_id: The webhook_id of this InlineResponse2014. + :type: str + """ + + self._webhook_id = webhook_id + + @property + def organization_id(self): + """ + Gets the organization_id of this InlineResponse2014. + Organization ID + + :return: The organization_id of this InlineResponse2014. + :rtype: str + """ + return self._organization_id + + @organization_id.setter + def organization_id(self, organization_id): + """ + Sets the organization_id of this InlineResponse2014. + Organization ID + + :param organization_id: The organization_id of this InlineResponse2014. + :type: str + """ + + self._organization_id = organization_id + + @property + def product_id(self): + """ + Gets the product_id of this InlineResponse2014. + The product you are receiving a webhook for. + + :return: The product_id of this InlineResponse2014. + :rtype: str + """ + return self._product_id + + @product_id.setter + def product_id(self, product_id): + """ + Sets the product_id of this InlineResponse2014. + The product you are receiving a webhook for. + + :param product_id: The product_id of this InlineResponse2014. + :type: str + """ + + self._product_id = product_id + + @property + def event_types(self): + """ + Gets the event_types of this InlineResponse2014. + Array of the different events for a given product id. + + :return: The event_types of this InlineResponse2014. + :rtype: list[str] + """ + return self._event_types + + @event_types.setter + def event_types(self, event_types): + """ + Sets the event_types of this InlineResponse2014. + Array of the different events for a given product id. + + :param event_types: The event_types of this InlineResponse2014. + :type: list[str] + """ + + self._event_types = event_types + + @property + def webhook_url(self): + """ + Gets the webhook_url of this InlineResponse2014. + The client's endpoint (URL) to receive webhooks. + + :return: The webhook_url of this InlineResponse2014. + :rtype: str + """ + return self._webhook_url + + @webhook_url.setter + def webhook_url(self, webhook_url): + """ + Sets the webhook_url of this InlineResponse2014. + The client's endpoint (URL) to receive webhooks. + + :param webhook_url: The webhook_url of this InlineResponse2014. + :type: str + """ + + self._webhook_url = webhook_url @property - def submit_time_utc(self): + def health_check_url(self): """ - Gets the submit_time_utc of this InlineResponse2014. - 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. + Gets the health_check_url of this InlineResponse2014. + The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. - :return: The submit_time_utc of this InlineResponse2014. + :return: The health_check_url of this InlineResponse2014. :rtype: str """ - return self._submit_time_utc + return self._health_check_url - @submit_time_utc.setter - def submit_time_utc(self, submit_time_utc): + @health_check_url.setter + def health_check_url(self, health_check_url): """ - Sets the submit_time_utc of this InlineResponse2014. - 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. + Sets the health_check_url of this InlineResponse2014. + The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. - :param submit_time_utc: The submit_time_utc of this InlineResponse2014. + :param health_check_url: The health_check_url of this InlineResponse2014. :type: str """ - self._submit_time_utc = submit_time_utc + self._health_check_url = health_check_url + + @property + def notification_scope(self): + """ + Gets the notification_scope of this InlineResponse2014. + + :return: The notification_scope of this InlineResponse2014. + :rtype: Notificationsubscriptionsv1webhooksNotificationScope + """ + return self._notification_scope + + @notification_scope.setter + def notification_scope(self, notification_scope): + """ + Sets the notification_scope of this InlineResponse2014. + + :param notification_scope: The notification_scope of this InlineResponse2014. + :type: Notificationsubscriptionsv1webhooksNotificationScope + """ + + self._notification_scope = notification_scope @property def status(self): """ Gets the status of this InlineResponse2014. - The status of the submitted transaction. Possible values: - ACCEPTED + Webhook status. :return: The status of this InlineResponse2014. :rtype: str @@ -100,7 +291,7 @@ def status(self): def status(self, status): """ Sets the status of this InlineResponse2014. - The status of the submitted transaction. Possible values: - ACCEPTED + Webhook status. :param status: The status of this InlineResponse2014. :type: str @@ -109,46 +300,161 @@ def status(self, status): self._status = status @property - def client_reference_information(self): + def name(self): + """ + Gets the name of this InlineResponse2014. + Client friendly webhook name. + + :return: The name of this InlineResponse2014. + :rtype: str + """ + return self._name + + @name.setter + def name(self, name): + """ + Sets the name of this InlineResponse2014. + Client friendly webhook name. + + :param name: The name of this InlineResponse2014. + :type: str + """ + + self._name = name + + @property + def description(self): + """ + Gets the description of this InlineResponse2014. + Client friendly webhook description. + + :return: The description of this InlineResponse2014. + :rtype: str + """ + return self._description + + @description.setter + def description(self, description): + """ + Sets the description of this InlineResponse2014. + Client friendly webhook description. + + :param description: The description of this InlineResponse2014. + :type: str + """ + + self._description = description + + @property + def retry_policy(self): + """ + Gets the retry_policy of this InlineResponse2014. + + :return: The retry_policy of this InlineResponse2014. + :rtype: Notificationsubscriptionsv1webhooksRetryPolicy """ - Gets the client_reference_information of this InlineResponse2014. + return self._retry_policy - :return: The client_reference_information of this InlineResponse2014. - :rtype: Kmsegressv2keyssymClientReferenceInformation + @retry_policy.setter + def retry_policy(self, retry_policy): """ - return self._client_reference_information + Sets the retry_policy of this InlineResponse2014. - @client_reference_information.setter - def client_reference_information(self, client_reference_information): + :param retry_policy: The retry_policy of this InlineResponse2014. + :type: Notificationsubscriptionsv1webhooksRetryPolicy """ - Sets the client_reference_information of this InlineResponse2014. - :param client_reference_information: The client_reference_information of this InlineResponse2014. - :type: Kmsegressv2keyssymClientReferenceInformation + self._retry_policy = retry_policy + + @property + def security_policy(self): + """ + Gets the security_policy of this InlineResponse2014. + + :return: The security_policy of this InlineResponse2014. + :rtype: Notificationsubscriptionsv1webhooksSecurityPolicy + """ + return self._security_policy + + @security_policy.setter + def security_policy(self, security_policy): + """ + Sets the security_policy of this InlineResponse2014. + + :param security_policy: The security_policy of this InlineResponse2014. + :type: Notificationsubscriptionsv1webhooksSecurityPolicy + """ + + self._security_policy = security_policy + + @property + def created_on(self): + """ + Gets the created_on of this InlineResponse2014. + Date on which webhook was created/registered. + + :return: The created_on of this InlineResponse2014. + :rtype: str + """ + return self._created_on + + @created_on.setter + def created_on(self, created_on): + """ + Sets the created_on of this InlineResponse2014. + Date on which webhook was created/registered. + + :param created_on: The created_on of this InlineResponse2014. + :type: str + """ + + self._created_on = created_on + + @property + def updated_on(self): + """ + Gets the updated_on of this InlineResponse2014. + Date on which webhook was most recently updated. + + :return: The updated_on of this InlineResponse2014. + :rtype: str + """ + return self._updated_on + + @updated_on.setter + def updated_on(self, updated_on): + """ + Sets the updated_on of this InlineResponse2014. + Date on which webhook was most recently updated. + + :param updated_on: The updated_on of this InlineResponse2014. + :type: str """ - self._client_reference_information = client_reference_information + self._updated_on = updated_on @property - def key_information(self): + def additional_attributes(self): """ - Gets the key_information of this InlineResponse2014. + Gets the additional_attributes of this InlineResponse2014. + Additional, free form configuration data. - :return: The key_information of this InlineResponse2014. - :rtype: Kmsegressv2keysasymKeyInformation + :return: The additional_attributes of this InlineResponse2014. + :rtype: list[dict(str, str)] """ - return self._key_information + return self._additional_attributes - @key_information.setter - def key_information(self, key_information): + @additional_attributes.setter + def additional_attributes(self, additional_attributes): """ - Sets the key_information of this InlineResponse2014. + Sets the additional_attributes of this InlineResponse2014. + Additional, free form configuration data. - :param key_information: The key_information of this InlineResponse2014. - :type: Kmsegressv2keysasymKeyInformation + :param additional_attributes: The additional_attributes of this InlineResponse2014. + :type: list[dict(str, str)] """ - self._key_information = key_information + self._additional_attributes = additional_attributes def to_dict(self): """ diff --git a/CyberSource/models/inline_response2015.py b/CyberSource/models/inline_response2015.py new file mode 100644 index 00000000..030a4bba --- /dev/null +++ b/CyberSource/models/inline_response2015.py @@ -0,0 +1,204 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class InlineResponse2015(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'submit_time_utc': 'str', + 'status': 'str', + 'client_reference_information': 'Kmsegressv2keyssymClientReferenceInformation', + 'key_information': 'Kmsegressv2keysasymKeyInformation' + } + + attribute_map = { + 'submit_time_utc': 'submitTimeUtc', + 'status': 'status', + 'client_reference_information': 'clientReferenceInformation', + 'key_information': 'keyInformation' + } + + def __init__(self, submit_time_utc=None, status=None, client_reference_information=None, key_information=None): + """ + InlineResponse2015 - a model defined in Swagger + """ + + self._submit_time_utc = None + self._status = None + self._client_reference_information = None + self._key_information = None + + if submit_time_utc is not None: + self.submit_time_utc = submit_time_utc + if status is not None: + self.status = status + if client_reference_information is not None: + self.client_reference_information = client_reference_information + if key_information is not None: + self.key_information = key_information + + @property + def submit_time_utc(self): + """ + Gets the submit_time_utc of this InlineResponse2015. + 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. + + :return: The submit_time_utc of this InlineResponse2015. + :rtype: str + """ + return self._submit_time_utc + + @submit_time_utc.setter + def submit_time_utc(self, submit_time_utc): + """ + Sets the submit_time_utc of this InlineResponse2015. + 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. + + :param submit_time_utc: The submit_time_utc of this InlineResponse2015. + :type: str + """ + + self._submit_time_utc = submit_time_utc + + @property + def status(self): + """ + Gets the status of this InlineResponse2015. + The status of the submitted transaction. Possible values: - ACCEPTED + + :return: The status of this InlineResponse2015. + :rtype: str + """ + return self._status + + @status.setter + def status(self, status): + """ + Sets the status of this InlineResponse2015. + The status of the submitted transaction. Possible values: - ACCEPTED + + :param status: The status of this InlineResponse2015. + :type: str + """ + + self._status = status + + @property + def client_reference_information(self): + """ + Gets the client_reference_information of this InlineResponse2015. + + :return: The client_reference_information of this InlineResponse2015. + :rtype: Kmsegressv2keyssymClientReferenceInformation + """ + return self._client_reference_information + + @client_reference_information.setter + def client_reference_information(self, client_reference_information): + """ + Sets the client_reference_information of this InlineResponse2015. + + :param client_reference_information: The client_reference_information of this InlineResponse2015. + :type: Kmsegressv2keyssymClientReferenceInformation + """ + + self._client_reference_information = client_reference_information + + @property + def key_information(self): + """ + Gets the key_information of this InlineResponse2015. + + :return: The key_information of this InlineResponse2015. + :rtype: Kmsegressv2keysasymKeyInformation + """ + return self._key_information + + @key_information.setter + def key_information(self, key_information): + """ + Sets the key_information of this InlineResponse2015. + + :param key_information: The key_information of this InlineResponse2015. + :type: Kmsegressv2keysasymKeyInformation + """ + + self._key_information = key_information + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, InlineResponse2015): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/invoicingv2invoices_order_information_amount_details_freight.py b/CyberSource/models/invoicingv2invoices_order_information_amount_details_freight.py index 9a0d31b0..5070c83a 100644 --- a/CyberSource/models/invoicingv2invoices_order_information_amount_details_freight.py +++ b/CyberSource/models/invoicingv2invoices_order_information_amount_details_freight.py @@ -84,7 +84,7 @@ def amount(self, amount): def taxable(self): """ Gets the taxable of this Invoicingv2invoicesOrderInformationAmountDetailsFreight. - 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** + 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. Possible values: - **true** - **false** :return: The taxable of this Invoicingv2invoicesOrderInformationAmountDetailsFreight. :rtype: bool @@ -95,7 +95,7 @@ def taxable(self): def taxable(self, taxable): """ Sets the taxable of this Invoicingv2invoicesOrderInformationAmountDetailsFreight. - 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** + 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. Possible values: - **true** - **false** :param taxable: The taxable of this Invoicingv2invoicesOrderInformationAmountDetailsFreight. :type: bool diff --git a/CyberSource/models/invoicingv2invoices_order_information_amount_details_tax_details.py b/CyberSource/models/invoicingv2invoices_order_information_amount_details_tax_details.py index fc778b40..ea9f76df 100644 --- a/CyberSource/models/invoicingv2invoices_order_information_amount_details_tax_details.py +++ b/CyberSource/models/invoicingv2invoices_order_information_amount_details_tax_details.py @@ -61,7 +61,7 @@ def __init__(self, type=None, amount=None, rate=None): def type(self): """ Gets the type of this Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails. - Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` :return: The type of this Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails. :rtype: str @@ -72,7 +72,7 @@ def type(self): def type(self, type): """ Sets the type of this Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails. - Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` :param type: The type of this Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails. :type: str @@ -107,7 +107,7 @@ def amount(self, amount): def rate(self): """ Gets the rate of this Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails. - Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) :return: The rate of this Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails. :rtype: str @@ -118,7 +118,7 @@ def rate(self): def rate(self, rate): """ Sets the rate of this Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails. - Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) :param rate: The rate of this Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails. :type: str diff --git a/CyberSource/models/invoicingv2invoices_order_information_line_items.py b/CyberSource/models/invoicingv2invoices_order_information_line_items.py index 19b5f375..db588196 100644 --- a/CyberSource/models/invoicingv2invoices_order_information_line_items.py +++ b/CyberSource/models/invoicingv2invoices_order_information_line_items.py @@ -160,7 +160,7 @@ def quantity(self, quantity): def unit_price(self): """ Gets the unit_price of this Invoicingv2invoicesOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Invoicingv2invoicesOrderInformationLineItems. :rtype: str @@ -171,7 +171,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Invoicingv2invoicesOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Invoicingv2invoicesOrderInformationLineItems. :type: str @@ -252,7 +252,7 @@ def tax_amount(self, tax_amount): def tax_rate(self): """ Gets the tax_rate of this Invoicingv2invoicesOrderInformationLineItems. - Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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%). + Tax rate applied to the item. **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%). :return: The tax_rate of this Invoicingv2invoicesOrderInformationLineItems. :rtype: str @@ -263,7 +263,7 @@ def tax_rate(self): def tax_rate(self, tax_rate): """ Sets the tax_rate of this Invoicingv2invoicesOrderInformationLineItems. - Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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%). + Tax rate applied to the item. **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%). :param tax_rate: The tax_rate of this Invoicingv2invoicesOrderInformationLineItems. :type: str diff --git a/CyberSource/models/merchant_initiated_transaction_object.py b/CyberSource/models/merchant_initiated_transaction_object.py index ac61fbe7..b90639dc 100644 --- a/CyberSource/models/merchant_initiated_transaction_object.py +++ b/CyberSource/models/merchant_initiated_transaction_object.py @@ -66,7 +66,7 @@ def __init__(self, reason=None, previous_transaction_id=None, original_authorize def reason(self): """ Gets the reason of this MerchantInitiatedTransactionObject. - Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code :return: The reason of this MerchantInitiatedTransactionObject. :rtype: str @@ -77,7 +77,7 @@ def reason(self): def reason(self, reason): """ Sets the reason of this MerchantInitiatedTransactionObject. - Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code :param reason: The reason of this MerchantInitiatedTransactionObject. :type: str @@ -112,7 +112,7 @@ def previous_transaction_id(self, previous_transaction_id): def original_authorized_amount(self): """ Gets the original_authorized_amount of this MerchantInitiatedTransactionObject. - Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. :return: The original_authorized_amount of this MerchantInitiatedTransactionObject. :rtype: str @@ -123,7 +123,7 @@ def original_authorized_amount(self): def original_authorized_amount(self, original_authorized_amount): """ Sets the original_authorized_amount of this MerchantInitiatedTransactionObject. - Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. :param original_authorized_amount: The original_authorized_amount of this MerchantInitiatedTransactionObject. :type: str diff --git a/CyberSource/models/pts_v2_incremental_authorization_patch201_response_processor_information.py b/CyberSource/models/pts_v2_incremental_authorization_patch201_response_processor_information.py index c3bc2584..3858e207 100644 --- a/CyberSource/models/pts_v2_incremental_authorization_patch201_response_processor_information.py +++ b/CyberSource/models/pts_v2_incremental_authorization_patch201_response_processor_information.py @@ -104,7 +104,7 @@ def approval_code(self, approval_code): def transaction_id(self): """ Gets the transaction_id of this PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :return: The transaction_id of this PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation. :rtype: str @@ -115,7 +115,7 @@ def transaction_id(self): def transaction_id(self, transaction_id): """ Sets the transaction_id of this PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :param transaction_id: The transaction_id of this PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation. :type: str diff --git a/CyberSource/models/pts_v2_payments_order_post201_response_processor_information.py b/CyberSource/models/pts_v2_payments_order_post201_response_processor_information.py index 1065807d..45b27118 100644 --- a/CyberSource/models/pts_v2_payments_order_post201_response_processor_information.py +++ b/CyberSource/models/pts_v2_payments_order_post201_response_processor_information.py @@ -108,7 +108,7 @@ def avs(self, avs): def transaction_id(self): """ Gets the transaction_id of this PtsV2PaymentsOrderPost201ResponseProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :return: The transaction_id of this PtsV2PaymentsOrderPost201ResponseProcessorInformation. :rtype: str @@ -119,7 +119,7 @@ def transaction_id(self): def transaction_id(self, transaction_id): """ Sets the transaction_id of this PtsV2PaymentsOrderPost201ResponseProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :param transaction_id: The transaction_id of this PtsV2PaymentsOrderPost201ResponseProcessorInformation. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response1_processor_information.py b/CyberSource/models/pts_v2_payments_post201_response1_processor_information.py index b906ea8e..4ffa0b0c 100644 --- a/CyberSource/models/pts_v2_payments_post201_response1_processor_information.py +++ b/CyberSource/models/pts_v2_payments_post201_response1_processor_information.py @@ -76,7 +76,7 @@ def __init__(self, transaction_id=None, trade_number=None, raw_response=None, re def transaction_id(self): """ Gets the transaction_id of this PtsV2PaymentsPost201Response1ProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :return: The transaction_id of this PtsV2PaymentsPost201Response1ProcessorInformation. :rtype: str @@ -87,7 +87,7 @@ def transaction_id(self): def transaction_id(self, transaction_id): """ Sets the transaction_id of this PtsV2PaymentsPost201Response1ProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :param transaction_id: The transaction_id of this PtsV2PaymentsPost201Response1ProcessorInformation. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response2_processor_information.py b/CyberSource/models/pts_v2_payments_post201_response2_processor_information.py index a4ccc003..a264ab37 100644 --- a/CyberSource/models/pts_v2_payments_post201_response2_processor_information.py +++ b/CyberSource/models/pts_v2_payments_post201_response2_processor_information.py @@ -71,7 +71,7 @@ def __init__(self, transaction_id=None, payment_url=None, response_details=None, def transaction_id(self): """ Gets the transaction_id of this PtsV2PaymentsPost201Response2ProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :return: The transaction_id of this PtsV2PaymentsPost201Response2ProcessorInformation. :rtype: str @@ -82,7 +82,7 @@ def transaction_id(self): def transaction_id(self, transaction_id): """ Sets the transaction_id of this PtsV2PaymentsPost201Response2ProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :param transaction_id: The transaction_id of this PtsV2PaymentsPost201Response2ProcessorInformation. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response_consumer_authentication_information.py b/CyberSource/models/pts_v2_payments_post201_response_consumer_authentication_information.py index 1d2b8287..e7b3520a 100644 --- a/CyberSource/models/pts_v2_payments_post201_response_consumer_authentication_information.py +++ b/CyberSource/models/pts_v2_payments_post201_response_consumer_authentication_information.py @@ -896,7 +896,7 @@ def signed_pares_status_reason(self, signed_pares_status_reason): def specification_version(self): """ Gets the specification_version of this PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation. - This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0. + This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 :return: The specification_version of this PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation. :rtype: str @@ -907,7 +907,7 @@ def specification_version(self): def specification_version(self, specification_version): """ Sets the specification_version of this PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation. - This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0. + This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 :param specification_version: The specification_version of this PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response_installment_information.py b/CyberSource/models/pts_v2_payments_post201_response_installment_information.py index c31f5243..9f4e2bff 100644 --- a/CyberSource/models/pts_v2_payments_post201_response_installment_information.py +++ b/CyberSource/models/pts_v2_payments_post201_response_installment_information.py @@ -176,7 +176,7 @@ def __init__(self, additional_costs=None, additional_costs_percentage=None, amou def additional_costs(self): """ Gets the additional_costs of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs + Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs :return: The additional_costs of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -187,7 +187,7 @@ def additional_costs(self): def additional_costs(self, additional_costs): """ Sets the additional_costs of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs + Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs :param additional_costs: The additional_costs of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -199,7 +199,7 @@ def additional_costs(self, additional_costs): def additional_costs_percentage(self): """ Gets the additional_costs_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs + Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs :return: The additional_costs_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -210,7 +210,7 @@ def additional_costs_percentage(self): def additional_costs_percentage(self, additional_costs_percentage): """ Sets the additional_costs_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs + Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs :param additional_costs_percentage: The additional_costs_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -222,7 +222,7 @@ def additional_costs_percentage(self, additional_costs_percentage): def amount(self): """ Gets the amount of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. :return: The amount of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -233,7 +233,7 @@ def amount(self): def amount(self, amount): """ Sets the amount of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. :param amount: The amount of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -245,7 +245,7 @@ def amount(self, amount): def amount_funded(self): """ Gets the amount_funded of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded + Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded :return: The amount_funded of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -256,7 +256,7 @@ def amount_funded(self): def amount_funded(self, amount_funded): """ Sets the amount_funded of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded + Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded :param amount_funded: The amount_funded of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -268,7 +268,7 @@ def amount_funded(self, amount_funded): def amount_requested_percentage(self): """ Gets the amount_requested_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested + Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested :return: The amount_requested_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -279,7 +279,7 @@ def amount_requested_percentage(self): def amount_requested_percentage(self, amount_requested_percentage): """ Sets the amount_requested_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested + Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested :param amount_requested_percentage: The amount_requested_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -291,7 +291,7 @@ def amount_requested_percentage(self, amount_requested_percentage): def annual_financing_cost(self): """ Gets the annual_financing_cost of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing + Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing :return: The annual_financing_cost of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -302,7 +302,7 @@ def annual_financing_cost(self): def annual_financing_cost(self, annual_financing_cost): """ Sets the annual_financing_cost of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing + Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing :param annual_financing_cost: The annual_financing_cost of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -314,7 +314,7 @@ def annual_financing_cost(self, annual_financing_cost): def annual_interest_rate(self): """ Gets the annual_interest_rate of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate + Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate :return: The annual_interest_rate of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -325,7 +325,7 @@ def annual_interest_rate(self): def annual_interest_rate(self, annual_interest_rate): """ Sets the annual_interest_rate of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate + Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate :param annual_interest_rate: The annual_interest_rate of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -337,7 +337,7 @@ def annual_interest_rate(self, annual_interest_rate): def expenses(self): """ Gets the expenses of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses + Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses :return: The expenses of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -348,7 +348,7 @@ def expenses(self): def expenses(self, expenses): """ Sets the expenses of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses + Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses :param expenses: The expenses of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -360,7 +360,7 @@ def expenses(self, expenses): def expenses_percentage(self): """ Gets the expenses_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses + Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses :return: The expenses_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -371,7 +371,7 @@ def expenses_percentage(self): def expenses_percentage(self, expenses_percentage): """ Sets the expenses_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses + Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses :param expenses_percentage: The expenses_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -383,7 +383,7 @@ def expenses_percentage(self, expenses_percentage): def fees(self): """ Gets the fees of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees + Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees :return: The fees of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -394,7 +394,7 @@ def fees(self): def fees(self, fees): """ Sets the fees of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees + Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees :param fees: The fees of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -406,7 +406,7 @@ def fees(self, fees): def fees_percentage(self): """ Gets the fees_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees + Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees :return: The fees_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -417,7 +417,7 @@ def fees_percentage(self): def fees_percentage(self, fees_percentage): """ Sets the fees_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees + Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees :param fees_percentage: The fees_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -429,7 +429,7 @@ def fees_percentage(self, fees_percentage): def frequency(self): """ Gets the frequency of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency :return: The frequency of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -440,7 +440,7 @@ def frequency(self): def frequency(self, frequency): """ Sets the frequency of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency :param frequency: The frequency of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -452,7 +452,7 @@ def frequency(self, frequency): def insurance(self): """ Gets the insurance of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance + Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance :return: The insurance of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -463,7 +463,7 @@ def insurance(self): def insurance(self, insurance): """ Sets the insurance of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance + Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance :param insurance: The insurance of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -475,7 +475,7 @@ def insurance(self, insurance): def insurance_percentage(self): """ Gets the insurance_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance + Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance :return: The insurance_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -486,7 +486,7 @@ def insurance_percentage(self): def insurance_percentage(self, insurance_percentage): """ Sets the insurance_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance + Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance :param insurance_percentage: The insurance_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -498,7 +498,7 @@ def insurance_percentage(self, insurance_percentage): def invoice_data(self): """ Gets the invoice_data of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification + Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification :return: The invoice_data of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -509,7 +509,7 @@ def invoice_data(self): def invoice_data(self, invoice_data): """ Sets the invoice_data of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification + Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification :param invoice_data: The invoice_data of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -521,7 +521,7 @@ def invoice_data(self, invoice_data): def monthly_interest_rate(self): """ Gets the monthly_interest_rate of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate + Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate :return: The monthly_interest_rate of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -532,7 +532,7 @@ def monthly_interest_rate(self): def monthly_interest_rate(self, monthly_interest_rate): """ Sets the monthly_interest_rate of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate + Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate :param monthly_interest_rate: The monthly_interest_rate of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -544,7 +544,7 @@ def monthly_interest_rate(self, monthly_interest_rate): def plan_type(self): """ Gets the plan_type of this PtsV2PaymentsPost201ResponseInstallmentInformation. - #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) + #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) :return: The plan_type of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -555,7 +555,7 @@ def plan_type(self): def plan_type(self, plan_type): """ Sets the plan_type of this PtsV2PaymentsPost201ResponseInstallmentInformation. - #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) + #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) :param plan_type: The plan_type of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -567,7 +567,7 @@ def plan_type(self, plan_type): def sequence(self): """ Gets the sequence of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :return: The sequence of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: int @@ -578,7 +578,7 @@ def sequence(self): def sequence(self, sequence): """ Sets the sequence of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :param sequence: The sequence of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: int @@ -590,7 +590,7 @@ def sequence(self, sequence): def taxes(self): """ Gets the taxes of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes + Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes :return: The taxes of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -601,7 +601,7 @@ def taxes(self): def taxes(self, taxes): """ Sets the taxes of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes + Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes :param taxes: The taxes of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -613,7 +613,7 @@ def taxes(self, taxes): def taxes_percentage(self): """ Gets the taxes_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes + Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes :return: The taxes_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -624,7 +624,7 @@ def taxes_percentage(self): def taxes_percentage(self, taxes_percentage): """ Sets the taxes_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes + Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes :param taxes_percentage: The taxes_percentage of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -636,7 +636,7 @@ def taxes_percentage(self, taxes_percentage): def total_amount(self): """ Gets the total_amount of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. :return: The total_amount of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -647,7 +647,7 @@ def total_amount(self): def total_amount(self, total_amount): """ Sets the total_amount of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. :param total_amount: The total_amount of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str @@ -659,7 +659,7 @@ def total_amount(self, total_amount): def total_count(self): """ Gets the total_count of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Total number of installments when making payments in installments. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :return: The total_count of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: int @@ -670,7 +670,7 @@ def total_count(self): def total_count(self, total_count): """ Sets the total_count of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Total number of installments when making payments in installments. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :param total_count: The total_count of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: int @@ -751,7 +751,7 @@ def first_installment_amount(self, first_installment_amount): def first_installment_date(self): """ Gets the first_installment_date of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment + Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment :return: The first_installment_date of this PtsV2PaymentsPost201ResponseInstallmentInformation. :rtype: str @@ -762,7 +762,7 @@ def first_installment_date(self): def first_installment_date(self, first_installment_date): """ Sets the first_installment_date of this PtsV2PaymentsPost201ResponseInstallmentInformation. - Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment + Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment :param first_installment_date: The first_installment_date of this PtsV2PaymentsPost201ResponseInstallmentInformation. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response_issuer_information.py b/CyberSource/models/pts_v2_payments_post201_response_issuer_information.py index 3e293a95..4955c120 100644 --- a/CyberSource/models/pts_v2_payments_post201_response_issuer_information.py +++ b/CyberSource/models/pts_v2_payments_post201_response_issuer_information.py @@ -71,7 +71,7 @@ def __init__(self, country=None, discretionary_data=None, country_specific_discr def country(self): """ Gets the country of this PtsV2PaymentsPost201ResponseIssuerInformation. - Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions. For details, see `auth_card_issuer_country` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions. :return: The country of this PtsV2PaymentsPost201ResponseIssuerInformation. :rtype: str @@ -82,7 +82,7 @@ def country(self): def country(self, country): """ Sets the country of this PtsV2PaymentsPost201ResponseIssuerInformation. - Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions. For details, see `auth_card_issuer_country` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions. :param country: The country of this PtsV2PaymentsPost201ResponseIssuerInformation. :type: str @@ -94,7 +94,7 @@ def country(self, country): def discretionary_data(self): """ Gets the discretionary_data of this PtsV2PaymentsPost201ResponseIssuerInformation. - Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. :return: The discretionary_data of this PtsV2PaymentsPost201ResponseIssuerInformation. :rtype: str @@ -105,7 +105,7 @@ def discretionary_data(self): def discretionary_data(self, discretionary_data): """ Sets the discretionary_data of this PtsV2PaymentsPost201ResponseIssuerInformation. - Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. :param discretionary_data: The discretionary_data of this PtsV2PaymentsPost201ResponseIssuerInformation. :type: str @@ -117,7 +117,7 @@ def discretionary_data(self, discretionary_data): def country_specific_discretionary_data(self): """ Gets the country_specific_discretionary_data of this PtsV2PaymentsPost201ResponseIssuerInformation. - Data defined by the issuer. This national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan. This subfield contains the Katakana text to be printed on the receipt. For details, see `jpo_issuer_message` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Data defined by the issuer. This national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan. This subfield contains the Katakana text to be printed on the receipt. :return: The country_specific_discretionary_data of this PtsV2PaymentsPost201ResponseIssuerInformation. :rtype: str @@ -128,7 +128,7 @@ def country_specific_discretionary_data(self): def country_specific_discretionary_data(self, country_specific_discretionary_data): """ Sets the country_specific_discretionary_data of this PtsV2PaymentsPost201ResponseIssuerInformation. - Data defined by the issuer. This national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan. This subfield contains the Katakana text to be printed on the receipt. For details, see `jpo_issuer_message` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Data defined by the issuer. This national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan. This subfield contains the Katakana text to be printed on the receipt. :param country_specific_discretionary_data: The country_specific_discretionary_data of this PtsV2PaymentsPost201ResponseIssuerInformation. :type: str @@ -140,7 +140,7 @@ def country_specific_discretionary_data(self, country_specific_discretionary_dat def response_code(self): """ Gets the response_code of this PtsV2PaymentsPost201ResponseIssuerInformation. - This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | | .... | ... | For details, see `issuerInformation. responseCode` field description in the [Credit Card Service Using the SCMP API Guide.] (https://developer.cybersource.com/content/dam/docs/cybs/en-us/api-fields/reference/all/rest/api-fields.pdf)| + This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | :return: The response_code of this PtsV2PaymentsPost201ResponseIssuerInformation. :rtype: str @@ -151,7 +151,7 @@ def response_code(self): def response_code(self, response_code): """ Sets the response_code of this PtsV2PaymentsPost201ResponseIssuerInformation. - This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | | .... | ... | For details, see `issuerInformation. responseCode` field description in the [Credit Card Service Using the SCMP API Guide.] (https://developer.cybersource.com/content/dam/docs/cybs/en-us/api-fields/reference/all/rest/api-fields.pdf)| + This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | :param response_code: The response_code of this PtsV2PaymentsPost201ResponseIssuerInformation. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response_payment_information_tokenized_card.py b/CyberSource/models/pts_v2_payments_post201_response_payment_information_tokenized_card.py index 8909624f..69ba26c0 100644 --- a/CyberSource/models/pts_v2_payments_post201_response_payment_information_tokenized_card.py +++ b/CyberSource/models/pts_v2_payments_post201_response_payment_information_tokenized_card.py @@ -86,7 +86,7 @@ def __init__(self, prefix=None, suffix=None, type=None, assurance_level=None, ex def prefix(self): """ Gets the prefix of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. - First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_prefix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/) + First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :return: The prefix of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. :rtype: str @@ -97,7 +97,7 @@ def prefix(self): def prefix(self, prefix): """ Sets the prefix of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. - First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_prefix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/) + First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :param prefix: The prefix of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. :type: str @@ -109,7 +109,7 @@ def prefix(self, prefix): def suffix(self): """ Gets the suffix of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. - Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_suffix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/) + Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :return: The suffix of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. :rtype: str @@ -120,7 +120,7 @@ def suffix(self): def suffix(self, suffix): """ Sets the suffix of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. - Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_suffix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/) + Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :param suffix: The suffix of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. :type: str @@ -178,7 +178,7 @@ def assurance_level(self, assurance_level): def expiration_month(self): """ Gets the expiration_month of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :return: The expiration_month of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. :rtype: str @@ -189,7 +189,7 @@ def expiration_month(self): def expiration_month(self, expiration_month): """ Sets the expiration_month of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :param expiration_month: The expiration_month of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. :type: str @@ -201,7 +201,7 @@ def expiration_month(self, expiration_month): def expiration_year(self): """ Gets the expiration_year of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :return: The expiration_year of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. :rtype: str @@ -212,7 +212,7 @@ def expiration_year(self): def expiration_year(self, expiration_year): """ Sets the expiration_year of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :param expiration_year: The expiration_year of this PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information.py b/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information.py index 7df4c1ec..e966f6bb 100644 --- a/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information.py +++ b/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information.py @@ -30,22 +30,27 @@ class PtsV2PaymentsPost201ResponsePaymentInsightsInformation(object): and the value is json key in definition. """ swagger_types = { - 'response_insights': 'PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights' + 'response_insights': 'PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights', + 'orchestration': 'PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration' } attribute_map = { - 'response_insights': 'responseInsights' + 'response_insights': 'responseInsights', + 'orchestration': 'orchestration' } - def __init__(self, response_insights=None): + def __init__(self, response_insights=None, orchestration=None): """ PtsV2PaymentsPost201ResponsePaymentInsightsInformation - a model defined in Swagger """ self._response_insights = None + self._orchestration = None if response_insights is not None: self.response_insights = response_insights + if orchestration is not None: + self.orchestration = orchestration @property def response_insights(self): @@ -68,6 +73,27 @@ def response_insights(self, response_insights): self._response_insights = response_insights + @property + def orchestration(self): + """ + Gets the orchestration of this PtsV2PaymentsPost201ResponsePaymentInsightsInformation. + + :return: The orchestration of this PtsV2PaymentsPost201ResponsePaymentInsightsInformation. + :rtype: PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration + """ + return self._orchestration + + @orchestration.setter + def orchestration(self, orchestration): + """ + Sets the orchestration of this PtsV2PaymentsPost201ResponsePaymentInsightsInformation. + + :param orchestration: The orchestration of this PtsV2PaymentsPost201ResponsePaymentInsightsInformation. + :type: PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration + """ + + self._orchestration = orchestration + def to_dict(self): """ Returns the model properties as a dict diff --git a/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information_orchestration.py b/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information_orchestration.py new file mode 100644 index 00000000..0a3e7443 --- /dev/null +++ b/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information_orchestration.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'info_codes': 'list[str]' + } + + attribute_map = { + 'info_codes': 'infoCodes' + } + + def __init__(self, info_codes=None): + """ + PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration - a model defined in Swagger + """ + + self._info_codes = None + + if info_codes is not None: + self.info_codes = info_codes + + @property + def info_codes(self): + """ + Gets the info_codes of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration. + Infocodes indicating which rules were triggered by the Service Orchestration product. + + :return: The info_codes of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration. + :rtype: list[str] + """ + return self._info_codes + + @info_codes.setter + def info_codes(self, info_codes): + """ + Sets the info_codes of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration. + Infocodes indicating which rules were triggered by the Service Orchestration product. + + :param info_codes: The info_codes of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration. + :type: list[str] + """ + + self._info_codes = info_codes + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information_response_insights.py b/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information_response_insights.py index 29fe57cf..48e72465 100644 --- a/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information_response_insights.py +++ b/CyberSource/models/pts_v2_payments_post201_response_payment_insights_information_response_insights.py @@ -61,7 +61,7 @@ def __init__(self, category=None, category_code=None, processor_raw_name=None): def category(self): """ Gets the category of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights. - Categorization of response message from processor Possible Values: - `APPROVED` - `ISSUER_WILL_NEVER_APPROVE` - `ISSUER_CANT_APPROVE_AT_THIS_TIME` - `ISSUER_CANT_APPROVE_WITH_THESE_DETAILS` - `GENERIC_ERROR` - `OTHERS` - `MATCH_NOT_FOUND` + Categorization of response message from processor Possible Values: - `ISSUER_WILL_NEVER_APPROVE` - `ISSUER_CANNOT_APPROVE_AT_THIS_TIME` - `ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS` - `GENERIC_ERROR` - `PAYMENT_INSIGHTS_INTERNAL_ERROR` - `OTHERS` - `PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND` :return: The category of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights. :rtype: str @@ -72,7 +72,7 @@ def category(self): def category(self, category): """ Sets the category of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights. - Categorization of response message from processor Possible Values: - `APPROVED` - `ISSUER_WILL_NEVER_APPROVE` - `ISSUER_CANT_APPROVE_AT_THIS_TIME` - `ISSUER_CANT_APPROVE_WITH_THESE_DETAILS` - `GENERIC_ERROR` - `OTHERS` - `MATCH_NOT_FOUND` + Categorization of response message from processor Possible Values: - `ISSUER_WILL_NEVER_APPROVE` - `ISSUER_CANNOT_APPROVE_AT_THIS_TIME` - `ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS` - `GENERIC_ERROR` - `PAYMENT_INSIGHTS_INTERNAL_ERROR` - `OTHERS` - `PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND` :param category: The category of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights. :type: str @@ -84,7 +84,7 @@ def category(self, category): def category_code(self): """ Gets the category_code of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights. - Categorization Code of response message from processor Possible Values: - `01` : Issuer Will Never Approve - `02` : Issuer Can't Approve at this Time - `03` : Issuer Can't Approve with these Details - `04` : Generic Error - `98` : Others - `99` : Payment Insights Response Category Match Not Found + Categorization Code of response message from processor Possible Values: - `01` : ISSUER_WILL_NEVER_APPROVE - `02` : ISSUER_CANNOT_APPROVE_AT_THIS_TIME - `03` : ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS - `04` : GENERIC_ERROR - `97` : PAYMENT_INSIGHTS_INTERNAL_ERROR - `98` : OTHERS - `99` : PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND :return: The category_code of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights. :rtype: str @@ -95,7 +95,7 @@ def category_code(self): def category_code(self, category_code): """ Sets the category_code of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights. - Categorization Code of response message from processor Possible Values: - `01` : Issuer Will Never Approve - `02` : Issuer Can't Approve at this Time - `03` : Issuer Can't Approve with these Details - `04` : Generic Error - `98` : Others - `99` : Payment Insights Response Category Match Not Found + Categorization Code of response message from processor Possible Values: - `01` : ISSUER_WILL_NEVER_APPROVE - `02` : ISSUER_CANNOT_APPROVE_AT_THIS_TIME - `03` : ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS - `04` : GENERIC_ERROR - `97` : PAYMENT_INSIGHTS_INTERNAL_ERROR - `98` : OTHERS - `99` : PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND :param category_code: The category_code of this PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response_point_of_sale_information.py b/CyberSource/models/pts_v2_payments_post201_response_point_of_sale_information.py index 48788719..00013650 100644 --- a/CyberSource/models/pts_v2_payments_post201_response_point_of_sale_information.py +++ b/CyberSource/models/pts_v2_payments_post201_response_point_of_sale_information.py @@ -82,7 +82,7 @@ def emv(self, emv): def amex_capn_data(self): """ Gets the amex_capn_data of this PtsV2PaymentsPost201ResponsePointOfSaleInformation. - Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. :return: The amex_capn_data of this PtsV2PaymentsPost201ResponsePointOfSaleInformation. :rtype: str @@ -93,7 +93,7 @@ def amex_capn_data(self): def amex_capn_data(self, amex_capn_data): """ Sets the amex_capn_data of this PtsV2PaymentsPost201ResponsePointOfSaleInformation. - Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. :param amex_capn_data: The amex_capn_data of this PtsV2PaymentsPost201ResponsePointOfSaleInformation. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response_processing_information.py b/CyberSource/models/pts_v2_payments_post201_response_processing_information.py index 74fb68f9..93cad954 100644 --- a/CyberSource/models/pts_v2_payments_post201_response_processing_information.py +++ b/CyberSource/models/pts_v2_payments_post201_response_processing_information.py @@ -82,7 +82,7 @@ def bank_transfer_options(self, bank_transfer_options): def payment_solution(self): """ Gets the payment_solution of this PtsV2PaymentsPost201ResponseProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :return: The payment_solution of this PtsV2PaymentsPost201ResponseProcessingInformation. :rtype: str @@ -93,7 +93,7 @@ def payment_solution(self): def payment_solution(self, payment_solution): """ Sets the payment_solution of this PtsV2PaymentsPost201ResponseProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :param payment_solution: The payment_solution of this PtsV2PaymentsPost201ResponseProcessingInformation. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response_processor_information.py b/CyberSource/models/pts_v2_payments_post201_response_processor_information.py index d7bb029d..7ca8f858 100644 --- a/CyberSource/models/pts_v2_payments_post201_response_processor_information.py +++ b/CyberSource/models/pts_v2_payments_post201_response_processor_information.py @@ -305,7 +305,7 @@ def card_reference_data(self, card_reference_data): def transaction_id(self): """ Gets the transaction_id of this PtsV2PaymentsPost201ResponseProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :return: The transaction_id of this PtsV2PaymentsPost201ResponseProcessorInformation. :rtype: str @@ -316,7 +316,7 @@ def transaction_id(self): def transaction_id(self, transaction_id): """ Sets the transaction_id of this PtsV2PaymentsPost201ResponseProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :param transaction_id: The transaction_id of this PtsV2PaymentsPost201ResponseProcessorInformation. :type: str diff --git a/CyberSource/models/pts_v2_payments_post201_response_processor_information_merchant_advice.py b/CyberSource/models/pts_v2_payments_post201_response_processor_information_merchant_advice.py index 3594ee98..9810f8a7 100644 --- a/CyberSource/models/pts_v2_payments_post201_response_processor_information_merchant_advice.py +++ b/CyberSource/models/pts_v2_payments_post201_response_processor_information_merchant_advice.py @@ -61,7 +61,7 @@ def __init__(self, code=None, code_raw=None, name_match=None): def code(self): """ Gets the code of this PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice. - - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | For processor-specific information, see the `auth_merchant_advice_code` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | :return: The code of this PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice. :rtype: str @@ -72,7 +72,7 @@ def code(self): def code(self, code): """ Sets the code of this PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice. - - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | For processor-specific information, see the `auth_merchant_advice_code` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | :param code: The code of this PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice. :type: str @@ -84,7 +84,7 @@ def code(self, code): def code_raw(self): """ Gets the code_raw of this PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice. - Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code For processor-specific information, see the `auth_merchant_advice_code_raw` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code :return: The code_raw of this PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice. :rtype: str @@ -95,7 +95,7 @@ def code_raw(self): def code_raw(self, code_raw): """ Sets the code_raw of this PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice. - Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code For processor-specific information, see the `auth_merchant_advice_code_raw` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code :param code_raw: The code_raw of this PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice. :type: str diff --git a/CyberSource/models/pts_v2_payments_reversals_post201_response_issuer_information.py b/CyberSource/models/pts_v2_payments_reversals_post201_response_issuer_information.py index d8edd26e..ad3b774a 100644 --- a/CyberSource/models/pts_v2_payments_reversals_post201_response_issuer_information.py +++ b/CyberSource/models/pts_v2_payments_reversals_post201_response_issuer_information.py @@ -51,7 +51,7 @@ def __init__(self, response_code=None): def response_code(self): """ Gets the response_code of this PtsV2PaymentsReversalsPost201ResponseIssuerInformation. - This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | | .... | ... | For details, see `issuerInformation. responseCode` field description in the [Credit Card Service Using the SCMP API Guide.] (https://developer.cybersource.com/content/dam/docs/cybs/en-us/api-fields/reference/all/rest/api-fields.pdf)| + This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | :return: The response_code of this PtsV2PaymentsReversalsPost201ResponseIssuerInformation. :rtype: str @@ -62,7 +62,7 @@ def response_code(self): def response_code(self, response_code): """ Sets the response_code of this PtsV2PaymentsReversalsPost201ResponseIssuerInformation. - This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | | .... | ... | For details, see `issuerInformation. responseCode` field description in the [Credit Card Service Using the SCMP API Guide.] (https://developer.cybersource.com/content/dam/docs/cybs/en-us/api-fields/reference/all/rest/api-fields.pdf)| + This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | :param response_code: The response_code of this PtsV2PaymentsReversalsPost201ResponseIssuerInformation. :type: str diff --git a/CyberSource/models/ptsv1pushfundstransfer_processing_information.py b/CyberSource/models/ptsv1pushfundstransfer_processing_information.py index 958046c9..60cd0657 100644 --- a/CyberSource/models/ptsv1pushfundstransfer_processing_information.py +++ b/CyberSource/models/ptsv1pushfundstransfer_processing_information.py @@ -31,26 +31,31 @@ class Ptsv1pushfundstransferProcessingInformation(object): """ swagger_types = { 'business_application_id': 'str', - 'payouts_options': 'Ptsv1pushfundstransferProcessingInformationPayoutsOptions' + 'payouts_options': 'Ptsv1pushfundstransferProcessingInformationPayoutsOptions', + 'enabler_id': 'str' } attribute_map = { 'business_application_id': 'businessApplicationId', - 'payouts_options': 'payoutsOptions' + 'payouts_options': 'payoutsOptions', + 'enabler_id': 'enablerId' } - def __init__(self, business_application_id=None, payouts_options=None): + def __init__(self, business_application_id=None, payouts_options=None, enabler_id=None): """ Ptsv1pushfundstransferProcessingInformation - a model defined in Swagger """ self._business_application_id = None self._payouts_options = None + self._enabler_id = None if business_application_id is not None: self.business_application_id = business_application_id if payouts_options is not None: self.payouts_options = payouts_options + if enabler_id is not None: + self.enabler_id = enabler_id @property def business_application_id(self): @@ -96,6 +101,29 @@ def payouts_options(self, payouts_options): self._payouts_options = payouts_options + @property + def enabler_id(self): + """ + Gets the enabler_id of this Ptsv1pushfundstransferProcessingInformation. + Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers. + + :return: The enabler_id of this Ptsv1pushfundstransferProcessingInformation. + :rtype: str + """ + return self._enabler_id + + @enabler_id.setter + def enabler_id(self, enabler_id): + """ + Sets the enabler_id of this Ptsv1pushfundstransferProcessingInformation. + Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers. + + :param enabler_id: The enabler_id of this Ptsv1pushfundstransferProcessingInformation. + :type: str + """ + + self._enabler_id = enabler_id + def to_dict(self): """ Returns the model properties as a dict diff --git a/CyberSource/models/ptsv2billingagreements_buyer_information.py b/CyberSource/models/ptsv2billingagreements_buyer_information.py index 110ce0dc..9eac6669 100644 --- a/CyberSource/models/ptsv2billingagreements_buyer_information.py +++ b/CyberSource/models/ptsv2billingagreements_buyer_information.py @@ -66,7 +66,7 @@ def __init__(self, merchant_customer_id=None, date_of_birth=None, gender=None, l def merchant_customer_id(self): """ Gets the merchant_customer_id of this Ptsv2billingagreementsBuyerInformation. - Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### SEPA/BACS Required for Create Mandate and Import Mandate #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### SEPA/BACS Required for Create Mandate and Import Mandate #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. :return: The merchant_customer_id of this Ptsv2billingagreementsBuyerInformation. :rtype: str @@ -77,7 +77,7 @@ def merchant_customer_id(self): def merchant_customer_id(self, merchant_customer_id): """ Sets the merchant_customer_id of this Ptsv2billingagreementsBuyerInformation. - Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### SEPA/BACS Required for Create Mandate and Import Mandate #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### SEPA/BACS Required for Create Mandate and Import Mandate #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. :param merchant_customer_id: The merchant_customer_id of this Ptsv2billingagreementsBuyerInformation. :type: str diff --git a/CyberSource/models/ptsv2billingagreements_installment_information.py b/CyberSource/models/ptsv2billingagreements_installment_information.py index ede2d972..f2a3f4d4 100644 --- a/CyberSource/models/ptsv2billingagreements_installment_information.py +++ b/CyberSource/models/ptsv2billingagreements_installment_information.py @@ -114,7 +114,7 @@ def alert_preference(self, alert_preference): def first_installment_date(self): """ Gets the first_installment_date of this Ptsv2billingagreementsInstallmentInformation. - Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment + Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment :return: The first_installment_date of this Ptsv2billingagreementsInstallmentInformation. :rtype: str @@ -125,7 +125,7 @@ def first_installment_date(self): def first_installment_date(self, first_installment_date): """ Sets the first_installment_date of this Ptsv2billingagreementsInstallmentInformation. - Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment + Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment :param first_installment_date: The first_installment_date of this Ptsv2billingagreementsInstallmentInformation. :type: str @@ -229,7 +229,7 @@ def min_amount(self, min_amount): def payment_type(self): """ Gets the payment_type of this Ptsv2billingagreementsInstallmentInformation. - Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information + Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information :return: The payment_type of this Ptsv2billingagreementsInstallmentInformation. :rtype: str @@ -240,7 +240,7 @@ def payment_type(self): def payment_type(self, payment_type): """ Sets the payment_type of this Ptsv2billingagreementsInstallmentInformation. - Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information + Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information :param payment_type: The payment_type of this Ptsv2billingagreementsInstallmentInformation. :type: str @@ -275,7 +275,7 @@ def preferred_day(self, preferred_day): def sequence(self): """ Gets the sequence of this Ptsv2billingagreementsInstallmentInformation. - Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :return: The sequence of this Ptsv2billingagreementsInstallmentInformation. :rtype: int @@ -286,7 +286,7 @@ def sequence(self): def sequence(self, sequence): """ Sets the sequence of this Ptsv2billingagreementsInstallmentInformation. - Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :param sequence: The sequence of this Ptsv2billingagreementsInstallmentInformation. :type: int diff --git a/CyberSource/models/ptsv2billingagreements_merchant_information.py b/CyberSource/models/ptsv2billingagreements_merchant_information.py index 1ab85c8b..5f4767ca 100644 --- a/CyberSource/models/ptsv2billingagreements_merchant_information.py +++ b/CyberSource/models/ptsv2billingagreements_merchant_information.py @@ -102,7 +102,7 @@ def merchant_descriptor(self, merchant_descriptor): def category_code(self): """ Gets the category_code of this Ptsv2billingagreementsMerchantInformation. - The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code + The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code :return: The category_code of this Ptsv2billingagreementsMerchantInformation. :rtype: int @@ -113,7 +113,7 @@ def category_code(self): def category_code(self, category_code): """ Sets the category_code of this Ptsv2billingagreementsMerchantInformation. - The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code + The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code :param category_code: The category_code of this Ptsv2billingagreementsMerchantInformation. :type: int diff --git a/CyberSource/models/ptsv2billingagreements_merchant_information_merchant_descriptor.py b/CyberSource/models/ptsv2billingagreements_merchant_information_merchant_descriptor.py index f048b835..e9b6b972 100644 --- a/CyberSource/models/ptsv2billingagreements_merchant_information_merchant_descriptor.py +++ b/CyberSource/models/ptsv2billingagreements_merchant_information_merchant_descriptor.py @@ -89,7 +89,7 @@ def postal_code(self, postal_code): def contact(self): """ Gets the contact of this Ptsv2billingagreementsMerchantInformationMerchantDescriptor. - For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) + Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) :return: The contact of this Ptsv2billingagreementsMerchantInformationMerchantDescriptor. :rtype: str @@ -100,7 +100,7 @@ def contact(self): def contact(self, contact): """ Sets the contact of this Ptsv2billingagreementsMerchantInformationMerchantDescriptor. - For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) + Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) :param contact: The contact of this Ptsv2billingagreementsMerchantInformationMerchantDescriptor. :type: str diff --git a/CyberSource/models/ptsv2billingagreements_payment_information_tokenized_card.py b/CyberSource/models/ptsv2billingagreements_payment_information_tokenized_card.py index 73816238..378f6396 100644 --- a/CyberSource/models/ptsv2billingagreements_payment_information_tokenized_card.py +++ b/CyberSource/models/ptsv2billingagreements_payment_information_tokenized_card.py @@ -99,7 +99,7 @@ def cryptogram(self, cryptogram): def expiration_month(self): """ Gets the expiration_month of this Ptsv2billingagreementsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :return: The expiration_month of this Ptsv2billingagreementsPaymentInformationTokenizedCard. :rtype: str @@ -110,7 +110,7 @@ def expiration_month(self): def expiration_month(self, expiration_month): """ Sets the expiration_month of this Ptsv2billingagreementsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :param expiration_month: The expiration_month of this Ptsv2billingagreementsPaymentInformationTokenizedCard. :type: str @@ -122,7 +122,7 @@ def expiration_month(self, expiration_month): def expiration_year(self): """ Gets the expiration_year of this Ptsv2billingagreementsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :return: The expiration_year of this Ptsv2billingagreementsPaymentInformationTokenizedCard. :rtype: str @@ -133,7 +133,7 @@ def expiration_year(self): def expiration_year(self, expiration_year): """ Sets the expiration_year of this Ptsv2billingagreementsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :param expiration_year: The expiration_year of this Ptsv2billingagreementsPaymentInformationTokenizedCard. :type: str diff --git a/CyberSource/models/ptsv2credits_installment_information.py b/CyberSource/models/ptsv2credits_installment_information.py index 6da49b58..51e4fa4d 100644 --- a/CyberSource/models/ptsv2credits_installment_information.py +++ b/CyberSource/models/ptsv2credits_installment_information.py @@ -51,7 +51,7 @@ def __init__(self, plan_type=None): def plan_type(self): """ Gets the plan_type of this Ptsv2creditsInstallmentInformation. - #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) + #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) :return: The plan_type of this Ptsv2creditsInstallmentInformation. :rtype: str @@ -62,7 +62,7 @@ def plan_type(self): def plan_type(self, plan_type): """ Sets the plan_type of this Ptsv2creditsInstallmentInformation. - #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) + #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) :param plan_type: The plan_type of this Ptsv2creditsInstallmentInformation. :type: str diff --git a/CyberSource/models/ptsv2credits_processing_information.py b/CyberSource/models/ptsv2credits_processing_information.py index 2c5116bf..7b924bdf 100644 --- a/CyberSource/models/ptsv2credits_processing_information.py +++ b/CyberSource/models/ptsv2credits_processing_information.py @@ -187,7 +187,7 @@ def processor_id(self, processor_id): def payment_solution(self): """ Gets the payment_solution of this Ptsv2creditsProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :return: The payment_solution of this Ptsv2creditsProcessingInformation. :rtype: str @@ -198,7 +198,7 @@ def payment_solution(self): def payment_solution(self, payment_solution): """ Sets the payment_solution of this Ptsv2creditsProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :param payment_solution: The payment_solution of this Ptsv2creditsProcessingInformation. :type: str diff --git a/CyberSource/models/ptsv2paymentreferences_order_information_line_items.py b/CyberSource/models/ptsv2paymentreferences_order_information_line_items.py index 07551cfd..445a4854 100644 --- a/CyberSource/models/ptsv2paymentreferences_order_information_line_items.py +++ b/CyberSource/models/ptsv2paymentreferences_order_information_line_items.py @@ -170,7 +170,7 @@ def quantity(self, quantity): def unit_price(self): """ Gets the unit_price of this Ptsv2paymentreferencesOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Ptsv2paymentreferencesOrderInformationLineItems. :rtype: str @@ -181,7 +181,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Ptsv2paymentreferencesOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Ptsv2paymentreferencesOrderInformationLineItems. :type: str @@ -262,7 +262,7 @@ def tax_amount(self, tax_amount): def tax_rate(self): """ Gets the tax_rate of this Ptsv2paymentreferencesOrderInformationLineItems. - Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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%). + Tax rate applied to the item. **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%). :return: The tax_rate of this Ptsv2paymentreferencesOrderInformationLineItems. :rtype: str @@ -273,7 +273,7 @@ def tax_rate(self): def tax_rate(self, tax_rate): """ Sets the tax_rate of this Ptsv2paymentreferencesOrderInformationLineItems. - Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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%). + Tax rate applied to the item. **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%). :param tax_rate: The tax_rate of this Ptsv2paymentreferencesOrderInformationLineItems. :type: str @@ -308,7 +308,7 @@ def total_amount(self, total_amount): def product_code(self): """ Gets the product_code of this Ptsv2paymentreferencesOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :return: The product_code of this Ptsv2paymentreferencesOrderInformationLineItems. :rtype: str @@ -319,7 +319,7 @@ def product_code(self): def product_code(self, product_code): """ Sets the product_code of this Ptsv2paymentreferencesOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :param product_code: The product_code of this Ptsv2paymentreferencesOrderInformationLineItems. :type: str diff --git a/CyberSource/models/ptsv2paymentreferences_order_information_ship_to.py b/CyberSource/models/ptsv2paymentreferences_order_information_ship_to.py index 9a39d317..7947235a 100644 --- a/CyberSource/models/ptsv2paymentreferences_order_information_ship_to.py +++ b/CyberSource/models/ptsv2paymentreferences_order_information_ship_to.py @@ -251,7 +251,7 @@ def last_name(self, last_name): def company(self): """ Gets the company of this Ptsv2paymentreferencesOrderInformationShipTo. - Name of the customer's company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Name of the customer's company. :return: The company of this Ptsv2paymentreferencesOrderInformationShipTo. :rtype: str @@ -262,7 +262,7 @@ def company(self): def company(self, company): """ Sets the company of this Ptsv2paymentreferencesOrderInformationShipTo. - Name of the customer's company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Name of the customer's company. :param company: The company of this Ptsv2paymentreferencesOrderInformationShipTo. :type: str diff --git a/CyberSource/models/ptsv2payments_aggregator_information_sub_merchant.py b/CyberSource/models/ptsv2payments_aggregator_information_sub_merchant.py index 3c026e35..2d479e6d 100644 --- a/CyberSource/models/ptsv2payments_aggregator_information_sub_merchant.py +++ b/CyberSource/models/ptsv2payments_aggregator_information_sub_merchant.py @@ -170,7 +170,7 @@ def name(self, name): def address1(self): """ Gets the address1 of this Ptsv2paymentsAggregatorInformationSubMerchant. - First line of the sub-merchant's street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + First line of the sub-merchant's street address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :return: The address1 of this Ptsv2paymentsAggregatorInformationSubMerchant. :rtype: str @@ -181,7 +181,7 @@ def address1(self): def address1(self, address1): """ Sets the address1 of this Ptsv2paymentsAggregatorInformationSubMerchant. - First line of the sub-merchant's street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + First line of the sub-merchant's street address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :param address1: The address1 of this Ptsv2paymentsAggregatorInformationSubMerchant. :type: str @@ -193,7 +193,7 @@ def address1(self, address1): def locality(self): """ Gets the locality of this Ptsv2paymentsAggregatorInformationSubMerchant. - Sub-merchant's city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Sub-merchant's city. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :return: The locality of this Ptsv2paymentsAggregatorInformationSubMerchant. :rtype: str @@ -204,7 +204,7 @@ def locality(self): def locality(self, locality): """ Sets the locality of this Ptsv2paymentsAggregatorInformationSubMerchant. - Sub-merchant's city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Sub-merchant's city. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :param locality: The locality of this Ptsv2paymentsAggregatorInformationSubMerchant. :type: str @@ -216,7 +216,7 @@ def locality(self, locality): def administrative_area(self): """ Gets the administrative_area of this Ptsv2paymentsAggregatorInformationSubMerchant. - Sub-merchant's state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Sub-merchant's state or province. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :return: The administrative_area of this Ptsv2paymentsAggregatorInformationSubMerchant. :rtype: str @@ -227,7 +227,7 @@ def administrative_area(self): def administrative_area(self, administrative_area): """ Sets the administrative_area of this Ptsv2paymentsAggregatorInformationSubMerchant. - Sub-merchant's state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Sub-merchant's state or province. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :param administrative_area: The administrative_area of this Ptsv2paymentsAggregatorInformationSubMerchant. :type: str @@ -239,7 +239,7 @@ def administrative_area(self, administrative_area): def region(self): """ Gets the region of this Ptsv2paymentsAggregatorInformationSubMerchant. - Sub-merchant's region. **Example**\\ `NE` indicates that the sub-merchant is in the northeast region. For processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Sub-merchant's region. **Example**\\ `NE` indicates that the sub-merchant is in the northeast region. :return: The region of this Ptsv2paymentsAggregatorInformationSubMerchant. :rtype: str @@ -250,7 +250,7 @@ def region(self): def region(self, region): """ Sets the region of this Ptsv2paymentsAggregatorInformationSubMerchant. - Sub-merchant's region. **Example**\\ `NE` indicates that the sub-merchant is in the northeast region. For processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Sub-merchant's region. **Example**\\ `NE` indicates that the sub-merchant is in the northeast region. :param region: The region of this Ptsv2paymentsAggregatorInformationSubMerchant. :type: str @@ -262,7 +262,7 @@ def region(self, region): def postal_code(self): """ Gets the postal_code of this Ptsv2paymentsAggregatorInformationSubMerchant. - Partial postal code for the sub-merchant's address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Partial postal code for the sub-merchant's address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :return: The postal_code of this Ptsv2paymentsAggregatorInformationSubMerchant. :rtype: str @@ -273,7 +273,7 @@ def postal_code(self): def postal_code(self, postal_code): """ Sets the postal_code of this Ptsv2paymentsAggregatorInformationSubMerchant. - Partial postal code for the sub-merchant's address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Partial postal code for the sub-merchant's address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :param postal_code: The postal_code of this Ptsv2paymentsAggregatorInformationSubMerchant. :type: str @@ -285,7 +285,7 @@ def postal_code(self, postal_code): def country(self): """ Gets the country of this Ptsv2paymentsAggregatorInformationSubMerchant. - Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. For details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. :return: The country of this Ptsv2paymentsAggregatorInformationSubMerchant. :rtype: str @@ -296,7 +296,7 @@ def country(self): def country(self, country): """ Sets the country of this Ptsv2paymentsAggregatorInformationSubMerchant. - Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. For details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. :param country: The country of this Ptsv2paymentsAggregatorInformationSubMerchant. :type: str diff --git a/CyberSource/models/ptsv2payments_consumer_authentication_information.py b/CyberSource/models/ptsv2payments_consumer_authentication_information.py index bb153f1c..fafbc80b 100644 --- a/CyberSource/models/ptsv2payments_consumer_authentication_information.py +++ b/CyberSource/models/ptsv2payments_consumer_authentication_information.py @@ -559,7 +559,7 @@ def strong_authentication(self, strong_authentication): def directory_server_transaction_id(self): """ Gets the directory_server_transaction_id of this Ptsv2paymentsConsumerAuthenticationInformation. - 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 + 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 :return: The directory_server_transaction_id of this Ptsv2paymentsConsumerAuthenticationInformation. :rtype: str @@ -570,7 +570,7 @@ def directory_server_transaction_id(self): def directory_server_transaction_id(self, directory_server_transaction_id): """ Sets the directory_server_transaction_id of this Ptsv2paymentsConsumerAuthenticationInformation. - 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 + 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 :param directory_server_transaction_id: The directory_server_transaction_id of this Ptsv2paymentsConsumerAuthenticationInformation. :type: str @@ -582,7 +582,7 @@ def directory_server_transaction_id(self, directory_server_transaction_id): def pa_specification_version(self): """ Gets the pa_specification_version of this Ptsv2paymentsConsumerAuthenticationInformation. - This field contains 3DS version that was used for Secured Consumer Authentication (SCA). For example 3DS secure version 1.0.2 or 2.0.0 is used for Secured Consumer Authentication. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 113 , Field: MC AVV Verification—Program Protocol It will contain one of the following values: - `1` (3D Secure Version 1.0 (3DS 1.0)) - `2` (EMV 3-D Secure (3DS 2.0)) For Cybersource connection through Visanet, below are additional values to be supported. - `2.1.0` (EMV 3D Secure Version 2.1) - `2.2.0` (EMV 3D Secure Version 2.2) - `2.3.0` (EMV 3D Secure Version 2.3) - `2.4.0` (EMV 3D Secure Version 2.4) - `2.5.0` (EMV 3D Secure Version 2.5) - `2.6.0` (EMV 3D Secure Version 2.6) - `2.7.0` (EMV 3D Secure Version 2.7) - `2.8.0` (EMV 3D Secure Version 2.8) - `2.9.0` (EMV 3D Secure Version 2.9) + This field contains 3DS version that was used for Secured Consumer Authentication (SCA). The value for this field should be in the format major.minor.patch version. Valid Values are: - `2.1.0` (EMV 3D Secure Version 2.1) - `2.2.0` (EMV 3D Secure Version 2.2) - `2.3.0` (EMV 3D Secure Version 2.3) - `2.4.0` (EMV 3D Secure Version 2.4) - `2.5.0` (EMV 3D Secure Version 2.5) - `2.6.0` (EMV 3D Secure Version 2.6) - `2.7.0` (EMV 3D Secure Version 2.7) - `2.8.0` (EMV 3D Secure Version 2.8) - `2.9.0` (EMV 3D Secure Version 2.9) For Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 113 , Field: MC AVV Verification—Program Protocol It will contain one of the following values: - `1` (3D Secure Version 1.x (3DS 1.0)) - `2` (EMV 3-D Secure (3DS 2.x)) :return: The pa_specification_version of this Ptsv2paymentsConsumerAuthenticationInformation. :rtype: str @@ -593,7 +593,7 @@ def pa_specification_version(self): def pa_specification_version(self, pa_specification_version): """ Sets the pa_specification_version of this Ptsv2paymentsConsumerAuthenticationInformation. - This field contains 3DS version that was used for Secured Consumer Authentication (SCA). For example 3DS secure version 1.0.2 or 2.0.0 is used for Secured Consumer Authentication. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 113 , Field: MC AVV Verification—Program Protocol It will contain one of the following values: - `1` (3D Secure Version 1.0 (3DS 1.0)) - `2` (EMV 3-D Secure (3DS 2.0)) For Cybersource connection through Visanet, below are additional values to be supported. - `2.1.0` (EMV 3D Secure Version 2.1) - `2.2.0` (EMV 3D Secure Version 2.2) - `2.3.0` (EMV 3D Secure Version 2.3) - `2.4.0` (EMV 3D Secure Version 2.4) - `2.5.0` (EMV 3D Secure Version 2.5) - `2.6.0` (EMV 3D Secure Version 2.6) - `2.7.0` (EMV 3D Secure Version 2.7) - `2.8.0` (EMV 3D Secure Version 2.8) - `2.9.0` (EMV 3D Secure Version 2.9) + This field contains 3DS version that was used for Secured Consumer Authentication (SCA). The value for this field should be in the format major.minor.patch version. Valid Values are: - `2.1.0` (EMV 3D Secure Version 2.1) - `2.2.0` (EMV 3D Secure Version 2.2) - `2.3.0` (EMV 3D Secure Version 2.3) - `2.4.0` (EMV 3D Secure Version 2.4) - `2.5.0` (EMV 3D Secure Version 2.5) - `2.6.0` (EMV 3D Secure Version 2.6) - `2.7.0` (EMV 3D Secure Version 2.7) - `2.8.0` (EMV 3D Secure Version 2.8) - `2.9.0` (EMV 3D Secure Version 2.9) For Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 113 , Field: MC AVV Verification—Program Protocol It will contain one of the following values: - `1` (3D Secure Version 1.x (3DS 1.0)) - `2` (EMV 3-D Secure (3DS 2.x)) :param pa_specification_version: The pa_specification_version of this Ptsv2paymentsConsumerAuthenticationInformation. :type: str diff --git a/CyberSource/models/ptsv2payments_installment_information.py b/CyberSource/models/ptsv2payments_installment_information.py index 9f2f3dcc..4a910554 100644 --- a/CyberSource/models/ptsv2payments_installment_information.py +++ b/CyberSource/models/ptsv2payments_installment_information.py @@ -121,7 +121,7 @@ def __init__(self, amount=None, frequency=None, plan_type=None, sequence=None, t def amount(self): """ Gets the amount of this Ptsv2paymentsInstallmentInformation. - Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. :return: The amount of this Ptsv2paymentsInstallmentInformation. :rtype: str @@ -132,7 +132,7 @@ def amount(self): def amount(self, amount): """ Sets the amount of this Ptsv2paymentsInstallmentInformation. - Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. :param amount: The amount of this Ptsv2paymentsInstallmentInformation. :type: str @@ -144,7 +144,7 @@ def amount(self, amount): def frequency(self): """ Gets the frequency of this Ptsv2paymentsInstallmentInformation. - Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency :return: The frequency of this Ptsv2paymentsInstallmentInformation. :rtype: str @@ -155,7 +155,7 @@ def frequency(self): def frequency(self, frequency): """ Sets the frequency of this Ptsv2paymentsInstallmentInformation. - Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency :param frequency: The frequency of this Ptsv2paymentsInstallmentInformation. :type: str @@ -167,7 +167,7 @@ def frequency(self, frequency): def plan_type(self): """ Gets the plan_type of this Ptsv2paymentsInstallmentInformation. - #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) + #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) :return: The plan_type of this Ptsv2paymentsInstallmentInformation. :rtype: str @@ -178,7 +178,7 @@ def plan_type(self): def plan_type(self, plan_type): """ Sets the plan_type of this Ptsv2paymentsInstallmentInformation. - #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) + #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) :param plan_type: The plan_type of this Ptsv2paymentsInstallmentInformation. :type: str @@ -190,7 +190,7 @@ def plan_type(self, plan_type): def sequence(self): """ Gets the sequence of this Ptsv2paymentsInstallmentInformation. - Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :return: The sequence of this Ptsv2paymentsInstallmentInformation. :rtype: int @@ -201,7 +201,7 @@ def sequence(self): def sequence(self, sequence): """ Sets the sequence of this Ptsv2paymentsInstallmentInformation. - Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :param sequence: The sequence of this Ptsv2paymentsInstallmentInformation. :type: int @@ -213,7 +213,7 @@ def sequence(self, sequence): def total_amount(self): """ Gets the total_amount of this Ptsv2paymentsInstallmentInformation. - Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. :return: The total_amount of this Ptsv2paymentsInstallmentInformation. :rtype: str @@ -224,7 +224,7 @@ def total_amount(self): def total_amount(self, total_amount): """ Sets the total_amount of this Ptsv2paymentsInstallmentInformation. - Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. :param total_amount: The total_amount of this Ptsv2paymentsInstallmentInformation. :type: str @@ -236,7 +236,7 @@ def total_amount(self, total_amount): def total_count(self): """ Gets the total_count of this Ptsv2paymentsInstallmentInformation. - Total number of installments when making payments in installments. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :return: The total_count of this Ptsv2paymentsInstallmentInformation. :rtype: int @@ -247,7 +247,7 @@ def total_count(self): def total_count(self, total_count): """ Sets the total_count of this Ptsv2paymentsInstallmentInformation. - Total number of installments when making payments in installments. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :param total_count: The total_count of this Ptsv2paymentsInstallmentInformation. :type: int @@ -259,7 +259,7 @@ def total_count(self, total_count): def first_installment_date(self): """ Gets the first_installment_date of this Ptsv2paymentsInstallmentInformation. - Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment + Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment :return: The first_installment_date of this Ptsv2paymentsInstallmentInformation. :rtype: str @@ -270,7 +270,7 @@ def first_installment_date(self): def first_installment_date(self, first_installment_date): """ Sets the first_installment_date of this Ptsv2paymentsInstallmentInformation. - Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment + Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment :param first_installment_date: The first_installment_date of this Ptsv2paymentsInstallmentInformation. :type: str @@ -282,7 +282,7 @@ def first_installment_date(self, first_installment_date): def invoice_data(self): """ Gets the invoice_data of this Ptsv2paymentsInstallmentInformation. - Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification + Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification :return: The invoice_data of this Ptsv2paymentsInstallmentInformation. :rtype: str @@ -293,7 +293,7 @@ def invoice_data(self): def invoice_data(self, invoice_data): """ Sets the invoice_data of this Ptsv2paymentsInstallmentInformation. - Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification + Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification :param invoice_data: The invoice_data of this Ptsv2paymentsInstallmentInformation. :type: str @@ -305,7 +305,7 @@ def invoice_data(self, invoice_data): def payment_type(self): """ Gets the payment_type of this Ptsv2paymentsInstallmentInformation. - Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information + Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information :return: The payment_type of this Ptsv2paymentsInstallmentInformation. :rtype: str @@ -316,7 +316,7 @@ def payment_type(self): def payment_type(self, payment_type): """ Sets the payment_type of this Ptsv2paymentsInstallmentInformation. - Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information + Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information :param payment_type: The payment_type of this Ptsv2paymentsInstallmentInformation. :type: str @@ -328,7 +328,7 @@ def payment_type(self, payment_type): def eligibility_inquiry(self): """ Gets the eligibility_inquiry of this Ptsv2paymentsInstallmentInformation. - Indicates whether the authorization request is a Crediario eligibility inquiry. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. + Indicates whether the authorization request is a Crediario eligibility inquiry. Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. :return: The eligibility_inquiry of this Ptsv2paymentsInstallmentInformation. :rtype: str @@ -339,7 +339,7 @@ def eligibility_inquiry(self): def eligibility_inquiry(self, eligibility_inquiry): """ Sets the eligibility_inquiry of this Ptsv2paymentsInstallmentInformation. - Indicates whether the authorization request is a Crediario eligibility inquiry. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. + Indicates whether the authorization request is a Crediario eligibility inquiry. Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. :param eligibility_inquiry: The eligibility_inquiry of this Ptsv2paymentsInstallmentInformation. :type: str diff --git a/CyberSource/models/ptsv2payments_issuer_information.py b/CyberSource/models/ptsv2payments_issuer_information.py index e36e3b8b..8a9bbf70 100644 --- a/CyberSource/models/ptsv2payments_issuer_information.py +++ b/CyberSource/models/ptsv2payments_issuer_information.py @@ -51,7 +51,7 @@ def __init__(self, discretionary_data=None): def discretionary_data(self): """ Gets the discretionary_data of this Ptsv2paymentsIssuerInformation. - Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. :return: The discretionary_data of this Ptsv2paymentsIssuerInformation. :rtype: str @@ -62,7 +62,7 @@ def discretionary_data(self): def discretionary_data(self, discretionary_data): """ Sets the discretionary_data of this Ptsv2paymentsIssuerInformation. - Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. :param discretionary_data: The discretionary_data of this Ptsv2paymentsIssuerInformation. :type: str diff --git a/CyberSource/models/ptsv2payments_merchant_information.py b/CyberSource/models/ptsv2payments_merchant_information.py index d730910f..7fb19dc2 100644 --- a/CyberSource/models/ptsv2payments_merchant_information.py +++ b/CyberSource/models/ptsv2payments_merchant_information.py @@ -180,7 +180,7 @@ def domain_name(self, domain_name): def sales_organization_id(self): """ Gets the sales_organization_id of this Ptsv2paymentsMerchantInformation. - Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Independent Sales Organization ID This field is supported for Visa, Mastercard and Discover Transactions. **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Independent Sales Organization ID This field is supported for Visa, Mastercard and Discover Transactions. **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :return: The sales_organization_id of this Ptsv2paymentsMerchantInformation. :rtype: str @@ -191,7 +191,7 @@ def sales_organization_id(self): def sales_organization_id(self, sales_organization_id): """ Sets the sales_organization_id of this Ptsv2paymentsMerchantInformation. - Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Independent Sales Organization ID This field is supported for Visa, Mastercard and Discover Transactions. **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Independent Sales Organization ID This field is supported for Visa, Mastercard and Discover Transactions. **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :param sales_organization_id: The sales_organization_id of this Ptsv2paymentsMerchantInformation. :type: str @@ -203,7 +203,7 @@ def sales_organization_id(self, sales_organization_id): def category_code(self): """ Gets the category_code of this Ptsv2paymentsMerchantInformation. - The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code + The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code :return: The category_code of this Ptsv2paymentsMerchantInformation. :rtype: int @@ -214,7 +214,7 @@ def category_code(self): def category_code(self, category_code): """ Sets the category_code of this Ptsv2paymentsMerchantInformation. - The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code + The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code :param category_code: The category_code of this Ptsv2paymentsMerchantInformation. :type: int @@ -249,7 +249,7 @@ def category_code_domestic(self, category_code_domestic): def tax_id(self): """ Gets the tax_id of this Ptsv2paymentsMerchantInformation. - Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 :return: The tax_id of this Ptsv2paymentsMerchantInformation. :rtype: str @@ -260,7 +260,7 @@ def tax_id(self): def tax_id(self, tax_id): """ Sets the tax_id of this Ptsv2paymentsMerchantInformation. - Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 :param tax_id: The tax_id of this Ptsv2paymentsMerchantInformation. :type: str @@ -272,7 +272,7 @@ def tax_id(self, tax_id): def vat_registration_number(self): """ Gets the vat_registration_number of this Ptsv2paymentsMerchantInformation. - Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description 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) + Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. :return: The vat_registration_number of this Ptsv2paymentsMerchantInformation. :rtype: str @@ -283,7 +283,7 @@ def vat_registration_number(self): def vat_registration_number(self, vat_registration_number): """ Sets the vat_registration_number of this Ptsv2paymentsMerchantInformation. - Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description 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) + Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. :param vat_registration_number: The vat_registration_number of this Ptsv2paymentsMerchantInformation. :type: str @@ -295,7 +295,7 @@ def vat_registration_number(self, vat_registration_number): def card_acceptor_reference_number(self): """ Gets the card_acceptor_reference_number of this Ptsv2paymentsMerchantInformation. - Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description 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) + Reference number that facilitates card acceptor/corporation communication and record keeping. :return: The card_acceptor_reference_number of this Ptsv2paymentsMerchantInformation. :rtype: str @@ -306,7 +306,7 @@ def card_acceptor_reference_number(self): def card_acceptor_reference_number(self, card_acceptor_reference_number): """ Sets the card_acceptor_reference_number of this Ptsv2paymentsMerchantInformation. - Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description 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) + Reference number that facilitates card acceptor/corporation communication and record keeping. :param card_acceptor_reference_number: The card_acceptor_reference_number of this Ptsv2paymentsMerchantInformation. :type: str diff --git a/CyberSource/models/ptsv2payments_merchant_information_merchant_descriptor.py b/CyberSource/models/ptsv2payments_merchant_information_merchant_descriptor.py index 3accf261..af0617a3 100644 --- a/CyberSource/models/ptsv2payments_merchant_information_merchant_descriptor.py +++ b/CyberSource/models/ptsv2payments_merchant_information_merchant_descriptor.py @@ -139,7 +139,7 @@ def name(self, name): def alternate_name(self): """ Gets the alternate_name of this Ptsv2paymentsMerchantInformationMerchantDescriptor. - An alternate name for the merchant. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> + An alternate name for the merchant. :return: The alternate_name of this Ptsv2paymentsMerchantInformationMerchantDescriptor. :rtype: str @@ -150,7 +150,7 @@ def alternate_name(self): def alternate_name(self, alternate_name): """ Sets the alternate_name of this Ptsv2paymentsMerchantInformationMerchantDescriptor. - An alternate name for the merchant. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> + An alternate name for the merchant. :param alternate_name: The alternate_name of this Ptsv2paymentsMerchantInformationMerchantDescriptor. :type: str @@ -162,7 +162,7 @@ def alternate_name(self, alternate_name): def contact(self): """ Gets the contact of this Ptsv2paymentsMerchantInformationMerchantDescriptor. - For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) + Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) :return: The contact of this Ptsv2paymentsMerchantInformationMerchantDescriptor. :rtype: str @@ -173,7 +173,7 @@ def contact(self): def contact(self, contact): """ Sets the contact of this Ptsv2paymentsMerchantInformationMerchantDescriptor. - For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) + Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) :param contact: The contact of this Ptsv2paymentsMerchantInformationMerchantDescriptor. :type: str @@ -185,7 +185,7 @@ def contact(self, contact): def address1(self): """ Gets the address1 of this Ptsv2paymentsMerchantInformationMerchantDescriptor. - First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + First line of merchant's address. :return: The address1 of this Ptsv2paymentsMerchantInformationMerchantDescriptor. :rtype: str @@ -196,7 +196,7 @@ def address1(self): def address1(self, address1): """ Sets the address1 of this Ptsv2paymentsMerchantInformationMerchantDescriptor. - First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + First line of merchant's address. :param address1: The address1 of this Ptsv2paymentsMerchantInformationMerchantDescriptor. :type: str diff --git a/CyberSource/models/ptsv2payments_order_information_amount_details.py b/CyberSource/models/ptsv2payments_order_information_amount_details.py index 83a0b84b..9b2cfee0 100644 --- a/CyberSource/models/ptsv2payments_order_information_amount_details.py +++ b/CyberSource/models/ptsv2payments_order_information_amount_details.py @@ -57,7 +57,8 @@ class Ptsv2paymentsOrderInformationAmountDetails(object): 'original_currency': 'str', 'cashback_amount': 'str', 'currency_conversion': 'Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion', - 'order': 'Ptsv2paymentsOrderInformationAmountDetailsOrder' + 'order': 'Ptsv2paymentsOrderInformationAmountDetailsOrder', + 'anticipated_amount': 'str' } attribute_map = { @@ -88,10 +89,11 @@ class Ptsv2paymentsOrderInformationAmountDetails(object): 'original_currency': 'originalCurrency', 'cashback_amount': 'cashbackAmount', 'currency_conversion': 'currencyConversion', - 'order': 'order' + 'order': 'order', + 'anticipated_amount': 'anticipatedAmount' } - def __init__(self, gift_wrap_amount=None, total_amount=None, sub_total_amount=None, currency=None, discount_amount=None, duty_amount=None, gratuity_amount=None, tax_amount=None, national_tax_included=None, tax_applied_after_discount=None, tax_applied_level=None, tax_type_code=None, freight_amount=None, foreign_amount=None, foreign_currency=None, exchange_rate=None, exchange_rate_time_stamp=None, surcharge=None, settlement_amount=None, settlement_currency=None, amex_additional_amounts=None, tax_details=None, service_fee_amount=None, original_amount=None, original_currency=None, cashback_amount=None, currency_conversion=None, order=None): + def __init__(self, gift_wrap_amount=None, total_amount=None, sub_total_amount=None, currency=None, discount_amount=None, duty_amount=None, gratuity_amount=None, tax_amount=None, national_tax_included=None, tax_applied_after_discount=None, tax_applied_level=None, tax_type_code=None, freight_amount=None, foreign_amount=None, foreign_currency=None, exchange_rate=None, exchange_rate_time_stamp=None, surcharge=None, settlement_amount=None, settlement_currency=None, amex_additional_amounts=None, tax_details=None, service_fee_amount=None, original_amount=None, original_currency=None, cashback_amount=None, currency_conversion=None, order=None, anticipated_amount=None): """ Ptsv2paymentsOrderInformationAmountDetails - a model defined in Swagger """ @@ -124,6 +126,7 @@ def __init__(self, gift_wrap_amount=None, total_amount=None, sub_total_amount=No self._cashback_amount = None self._currency_conversion = None self._order = None + self._anticipated_amount = None if gift_wrap_amount is not None: self.gift_wrap_amount = gift_wrap_amount @@ -181,6 +184,8 @@ def __init__(self, gift_wrap_amount=None, total_amount=None, sub_total_amount=No self.currency_conversion = currency_conversion if order is not None: self.order = order + if anticipated_amount is not None: + self.anticipated_amount = anticipated_amount @property def gift_wrap_amount(self): @@ -816,6 +821,29 @@ def order(self, order): self._order = order + @property + def anticipated_amount(self): + """ + Gets the anticipated_amount of this Ptsv2paymentsOrderInformationAmountDetails. + This API Field contains the anticipated amount details. This supports use cases where the Merchant does not wish to have funds held against the account, but needs to confirm an amount prior to authorization, such as for a trial subscription, reservation service, or loyalty program. In an account verification, the anticipated amount is used to confirm the account has availability to accept purchases. + + :return: The anticipated_amount of this Ptsv2paymentsOrderInformationAmountDetails. + :rtype: str + """ + return self._anticipated_amount + + @anticipated_amount.setter + def anticipated_amount(self, anticipated_amount): + """ + Sets the anticipated_amount of this Ptsv2paymentsOrderInformationAmountDetails. + This API Field contains the anticipated amount details. This supports use cases where the Merchant does not wish to have funds held against the account, but needs to confirm an amount prior to authorization, such as for a trial subscription, reservation service, or loyalty program. In an account verification, the anticipated amount is used to confirm the account has availability to accept purchases. + + :param anticipated_amount: The anticipated_amount of this Ptsv2paymentsOrderInformationAmountDetails. + :type: str + """ + + self._anticipated_amount = anticipated_amount + def to_dict(self): """ Returns the model properties as a dict diff --git a/CyberSource/models/ptsv2payments_order_information_amount_details_order.py b/CyberSource/models/ptsv2payments_order_information_amount_details_order.py index cad77b67..7461f40c 100644 --- a/CyberSource/models/ptsv2payments_order_information_amount_details_order.py +++ b/CyberSource/models/ptsv2payments_order_information_amount_details_order.py @@ -229,7 +229,7 @@ def shipping_discount_amount(self, shipping_discount_amount): def tax_amount(self): """ Gets the tax_amount of this Ptsv2paymentsOrderInformationAmountDetailsOrder. - Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation. + Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation. :return: The tax_amount of this Ptsv2paymentsOrderInformationAmountDetailsOrder. :rtype: str @@ -240,7 +240,7 @@ def tax_amount(self): def tax_amount(self, tax_amount): """ Sets the tax_amount of this Ptsv2paymentsOrderInformationAmountDetailsOrder. - Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation. + Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation. :param tax_amount: The tax_amount of this Ptsv2paymentsOrderInformationAmountDetailsOrder. :type: str diff --git a/CyberSource/models/ptsv2payments_order_information_amount_details_tax_details.py b/CyberSource/models/ptsv2payments_order_information_amount_details_tax_details.py index 959f416a..08453dd6 100644 --- a/CyberSource/models/ptsv2payments_order_information_amount_details_tax_details.py +++ b/CyberSource/models/ptsv2payments_order_information_amount_details_tax_details.py @@ -81,7 +81,7 @@ def __init__(self, type=None, amount=None, rate=None, code=None, tax_id=None, ap def type(self): """ Gets the type of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` :return: The type of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :rtype: str @@ -92,7 +92,7 @@ def type(self): def type(self, type): """ Sets the type of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` :param type: The type of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :type: str @@ -127,7 +127,7 @@ def amount(self, amount): def rate(self): """ Gets the rate of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) :return: The rate of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :rtype: str @@ -138,7 +138,7 @@ def rate(self): def rate(self, rate): """ Sets the rate of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) :param rate: The rate of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :type: str @@ -150,7 +150,7 @@ def rate(self, rate): def code(self): """ Gets the code of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` + Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` :return: The code of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :rtype: str @@ -161,7 +161,7 @@ def code(self): def code(self, code): """ Sets the code of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` + Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` :param code: The code of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :type: str @@ -173,7 +173,7 @@ def code(self, code): def tax_id(self): """ Gets the tax_id of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. For processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. :return: The tax_id of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :rtype: str @@ -184,7 +184,7 @@ def tax_id(self): def tax_id(self, tax_id): """ Sets the tax_id of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. For processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. :param tax_id: The tax_id of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :type: str @@ -196,7 +196,7 @@ def tax_id(self, tax_id): def applied(self): """ Gets the applied of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. For processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. :return: The applied of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :rtype: bool @@ -207,7 +207,7 @@ def applied(self): def applied(self, applied): """ Sets the applied of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. For processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. :param applied: The applied of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :type: bool @@ -219,7 +219,7 @@ def applied(self, applied): def exemption_code(self): """ Gets the exemption_code of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. For possible values and important information for using this field, see _Appendix B, \"Exemption Status Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. :return: The exemption_code of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :rtype: str @@ -230,7 +230,7 @@ def exemption_code(self): def exemption_code(self, exemption_code): """ Sets the exemption_code of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. - Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. For possible values and important information for using this field, see _Appendix B, \"Exemption Status Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. :param exemption_code: The exemption_code of this Ptsv2paymentsOrderInformationAmountDetailsTaxDetails. :type: str diff --git a/CyberSource/models/ptsv2payments_order_information_invoice_details.py b/CyberSource/models/ptsv2payments_order_information_invoice_details.py index 1e898c1b..ceb712ff 100644 --- a/CyberSource/models/ptsv2payments_order_information_invoice_details.py +++ b/CyberSource/models/ptsv2payments_order_information_invoice_details.py @@ -205,7 +205,7 @@ def expiration_date(self, expiration_date): def purchase_order_number(self): """ Gets the purchase_order_number of this Ptsv2paymentsOrderInformationInvoiceDetails. - Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the `user_po` 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) + Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. :return: The purchase_order_number of this Ptsv2paymentsOrderInformationInvoiceDetails. :rtype: str @@ -216,7 +216,7 @@ def purchase_order_number(self): def purchase_order_number(self, purchase_order_number): """ Sets the purchase_order_number of this Ptsv2paymentsOrderInformationInvoiceDetails. - Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the `user_po` 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) + Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. :param purchase_order_number: The purchase_order_number of this Ptsv2paymentsOrderInformationInvoiceDetails. :type: str @@ -228,7 +228,7 @@ def purchase_order_number(self, purchase_order_number): def purchase_order_date(self): """ Gets the purchase_order_date of this Ptsv2paymentsOrderInformationInvoiceDetails. - Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the `purchaser_order_date` 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) + Date the order was processed. `Format: YYYY-MM-DD`. :return: The purchase_order_date of this Ptsv2paymentsOrderInformationInvoiceDetails. :rtype: str @@ -239,7 +239,7 @@ def purchase_order_date(self): def purchase_order_date(self, purchase_order_date): """ Sets the purchase_order_date of this Ptsv2paymentsOrderInformationInvoiceDetails. - Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the `purchaser_order_date` 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) + Date the order was processed. `Format: YYYY-MM-DD`. :param purchase_order_date: The purchase_order_date of this Ptsv2paymentsOrderInformationInvoiceDetails. :type: str @@ -251,7 +251,7 @@ def purchase_order_date(self, purchase_order_date): def purchase_contact_name(self): """ Gets the purchase_contact_name of this Ptsv2paymentsOrderInformationInvoiceDetails. - The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the `authorized_contact_name` 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) + The name of the individual or the company contacted for company authorized purchases. :return: The purchase_contact_name of this Ptsv2paymentsOrderInformationInvoiceDetails. :rtype: str @@ -262,7 +262,7 @@ def purchase_contact_name(self): def purchase_contact_name(self, purchase_contact_name): """ Sets the purchase_contact_name of this Ptsv2paymentsOrderInformationInvoiceDetails. - The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the `authorized_contact_name` 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) + The name of the individual or the company contacted for company authorized purchases. :param purchase_contact_name: The purchase_contact_name of this Ptsv2paymentsOrderInformationInvoiceDetails. :type: str @@ -274,7 +274,7 @@ def purchase_contact_name(self, purchase_contact_name): def taxable(self): """ Gets the taxable of this Ptsv2paymentsOrderInformationInvoiceDetails. - 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** + 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. Possible values: - **true** - **false** :return: The taxable of this Ptsv2paymentsOrderInformationInvoiceDetails. :rtype: bool @@ -285,7 +285,7 @@ def taxable(self): def taxable(self, taxable): """ Sets the taxable of this Ptsv2paymentsOrderInformationInvoiceDetails. - 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** + 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. Possible values: - **true** - **false** :param taxable: The taxable of this Ptsv2paymentsOrderInformationInvoiceDetails. :type: bool @@ -297,7 +297,7 @@ def taxable(self, taxable): def vat_invoice_reference_number(self): """ Gets the vat_invoice_reference_number of this Ptsv2paymentsOrderInformationInvoiceDetails. - VAT invoice number associated with the transaction. For processor-specific information, see the `vat_invoice_ref_number` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + VAT invoice number associated with the transaction. :return: The vat_invoice_reference_number of this Ptsv2paymentsOrderInformationInvoiceDetails. :rtype: str @@ -308,7 +308,7 @@ def vat_invoice_reference_number(self): def vat_invoice_reference_number(self, vat_invoice_reference_number): """ Sets the vat_invoice_reference_number of this Ptsv2paymentsOrderInformationInvoiceDetails. - VAT invoice number associated with the transaction. For processor-specific information, see the `vat_invoice_ref_number` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + VAT invoice number associated with the transaction. :param vat_invoice_reference_number: The vat_invoice_reference_number of this Ptsv2paymentsOrderInformationInvoiceDetails. :type: str @@ -320,7 +320,7 @@ def vat_invoice_reference_number(self, vat_invoice_reference_number): def commodity_code(self): """ Gets the commodity_code of this Ptsv2paymentsOrderInformationInvoiceDetails. - International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the `summary_commodity_code` 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) + International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. :return: The commodity_code of this Ptsv2paymentsOrderInformationInvoiceDetails. :rtype: str @@ -331,7 +331,7 @@ def commodity_code(self): def commodity_code(self, commodity_code): """ Sets the commodity_code of this Ptsv2paymentsOrderInformationInvoiceDetails. - International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the `summary_commodity_code` 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) + International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. :param commodity_code: The commodity_code of this Ptsv2paymentsOrderInformationInvoiceDetails. :type: str @@ -387,7 +387,7 @@ def transaction_advice_addendum(self, transaction_advice_addendum): def reference_data_code(self): """ Gets the reference_data_code of this Ptsv2paymentsOrderInformationInvoiceDetails. - Code that identifies the value of the `referenceDataNumber` field. For the possible values, see \"Reference Data Codes\" in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/). This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. + Code that identifies the value of the `referenceDataNumber` field. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. :return: The reference_data_code of this Ptsv2paymentsOrderInformationInvoiceDetails. :rtype: str @@ -398,7 +398,7 @@ def reference_data_code(self): def reference_data_code(self, reference_data_code): """ Sets the reference_data_code of this Ptsv2paymentsOrderInformationInvoiceDetails. - Code that identifies the value of the `referenceDataNumber` field. For the possible values, see \"Reference Data Codes\" in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/). This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. + Code that identifies the value of the `referenceDataNumber` field. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. :param reference_data_code: The reference_data_code of this Ptsv2paymentsOrderInformationInvoiceDetails. :type: str diff --git a/CyberSource/models/ptsv2payments_order_information_line_items.py b/CyberSource/models/ptsv2payments_order_information_line_items.py index 560c2e78..8309f1a6 100644 --- a/CyberSource/models/ptsv2payments_order_information_line_items.py +++ b/CyberSource/models/ptsv2payments_order_information_line_items.py @@ -216,7 +216,7 @@ def __init__(self, product_code=None, product_name=None, product_sku=None, quant def product_code(self): """ Gets the product_code of this Ptsv2paymentsOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :return: The product_code of this Ptsv2paymentsOrderInformationLineItems. :rtype: str @@ -227,7 +227,7 @@ def product_code(self): def product_code(self, product_code): """ Sets the product_code of this Ptsv2paymentsOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :param product_code: The product_code of this Ptsv2paymentsOrderInformationLineItems. :type: str @@ -308,7 +308,7 @@ def quantity(self, quantity): def unit_price(self): """ Gets the unit_price of this Ptsv2paymentsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Ptsv2paymentsOrderInformationLineItems. :rtype: str @@ -319,7 +319,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Ptsv2paymentsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Ptsv2paymentsOrderInformationLineItems. :type: str @@ -400,7 +400,7 @@ def tax_amount(self, tax_amount): def tax_rate(self): """ Gets the tax_rate of this Ptsv2paymentsOrderInformationLineItems. - Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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%). + Tax rate applied to the item. **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%). :return: The tax_rate of this Ptsv2paymentsOrderInformationLineItems. :rtype: str @@ -411,7 +411,7 @@ def tax_rate(self): def tax_rate(self, tax_rate): """ Sets the tax_rate of this Ptsv2paymentsOrderInformationLineItems. - Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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%). + Tax rate applied to the item. **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%). :param tax_rate: The tax_rate of this Ptsv2paymentsOrderInformationLineItems. :type: str @@ -469,7 +469,7 @@ def tax_status_indicator(self, tax_status_indicator): def tax_type_code(self): """ Gets the tax_type_code of this Ptsv2paymentsOrderInformationLineItems. - Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` + Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` :return: The tax_type_code of this Ptsv2paymentsOrderInformationLineItems. :rtype: str @@ -480,7 +480,7 @@ def tax_type_code(self): def tax_type_code(self, tax_type_code): """ Sets the tax_type_code of this Ptsv2paymentsOrderInformationLineItems. - Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` + Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` :param tax_type_code: The tax_type_code of this Ptsv2paymentsOrderInformationLineItems. :type: str @@ -697,7 +697,7 @@ def fulfillment_type(self, fulfillment_type): def weight(self): """ Gets the weight of this Ptsv2paymentsOrderInformationLineItems. - Weight of the item. For details, see `weight_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Weight of the item. :return: The weight of this Ptsv2paymentsOrderInformationLineItems. :rtype: str @@ -708,7 +708,7 @@ def weight(self): def weight(self, weight): """ Sets the weight of this Ptsv2paymentsOrderInformationLineItems. - Weight of the item. For details, see `weight_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Weight of the item. :param weight: The weight of this Ptsv2paymentsOrderInformationLineItems. :type: str @@ -720,7 +720,7 @@ def weight(self, weight): def weight_identifier(self): """ Gets the weight_identifier of this Ptsv2paymentsOrderInformationLineItems. - Type of weight. Possible values: - B: Billed weight - N: Actual net weight For details, see `weight_identifier` offer-level field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Type of weight. Possible values: - B: Billed weight - N: Actual net weight :return: The weight_identifier of this Ptsv2paymentsOrderInformationLineItems. :rtype: str @@ -731,7 +731,7 @@ def weight_identifier(self): def weight_identifier(self, weight_identifier): """ Sets the weight_identifier of this Ptsv2paymentsOrderInformationLineItems. - Type of weight. Possible values: - B: Billed weight - N: Actual net weight For details, see `weight_identifier` offer-level field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Type of weight. Possible values: - B: Billed weight - N: Actual net weight :param weight_identifier: The weight_identifier of this Ptsv2paymentsOrderInformationLineItems. :type: str @@ -743,7 +743,7 @@ def weight_identifier(self, weight_identifier): def weight_unit(self): """ Gets the weight_unit of this Ptsv2paymentsOrderInformationLineItems. - Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC). For details, see `weight_unit_measurement` offer-level field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC). :return: The weight_unit of this Ptsv2paymentsOrderInformationLineItems. :rtype: str @@ -754,7 +754,7 @@ def weight_unit(self): def weight_unit(self, weight_unit): """ Sets the weight_unit of this Ptsv2paymentsOrderInformationLineItems. - Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC). For details, see `weight_unit_measurement` offer-level field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC). :param weight_unit: The weight_unit of this Ptsv2paymentsOrderInformationLineItems. :type: str @@ -766,7 +766,7 @@ def weight_unit(self, weight_unit): def reference_data_code(self): """ Gets the reference_data_code of this Ptsv2paymentsOrderInformationLineItems. - Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field. Possible values: - AN: Client-defined asset code - MG: Manufacturer's part number - PO: Purchase order number - SK: Supplier stock keeping unit number - UP: Universal product code - VC: Supplier catalog number - VP: Vendor part number This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. For details, see `reference_data_#_code` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field. Possible values: - AN: Client-defined asset code - MG: Manufacturer's part number - PO: Purchase order number - SK: Supplier stock keeping unit number - UP: Universal product code - VC: Supplier catalog number - VP: Vendor part number This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. :return: The reference_data_code of this Ptsv2paymentsOrderInformationLineItems. :rtype: str @@ -777,7 +777,7 @@ def reference_data_code(self): def reference_data_code(self, reference_data_code): """ Sets the reference_data_code of this Ptsv2paymentsOrderInformationLineItems. - Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field. Possible values: - AN: Client-defined asset code - MG: Manufacturer's part number - PO: Purchase order number - SK: Supplier stock keeping unit number - UP: Universal product code - VC: Supplier catalog number - VP: Vendor part number This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. For details, see `reference_data_#_code` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field. Possible values: - AN: Client-defined asset code - MG: Manufacturer's part number - PO: Purchase order number - SK: Supplier stock keeping unit number - UP: Universal product code - VC: Supplier catalog number - VP: Vendor part number This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. :param reference_data_code: The reference_data_code of this Ptsv2paymentsOrderInformationLineItems. :type: str @@ -858,7 +858,7 @@ def product_description(self, product_description): def gift_card_currency(self): """ Gets the gift_card_currency of this Ptsv2paymentsOrderInformationLineItems. - When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) + When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) :return: The gift_card_currency of this Ptsv2paymentsOrderInformationLineItems. :rtype: int @@ -869,7 +869,7 @@ def gift_card_currency(self): def gift_card_currency(self, gift_card_currency): """ Sets the gift_card_currency of this Ptsv2paymentsOrderInformationLineItems. - When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) + When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) :param gift_card_currency: The gift_card_currency of this Ptsv2paymentsOrderInformationLineItems. :type: int diff --git a/CyberSource/models/ptsv2payments_order_information_ship_to.py b/CyberSource/models/ptsv2payments_order_information_ship_to.py index 079d32c6..006d3886 100644 --- a/CyberSource/models/ptsv2payments_order_information_ship_to.py +++ b/CyberSource/models/ptsv2payments_order_information_ship_to.py @@ -486,7 +486,7 @@ def email(self, email): def company(self): """ Gets the company of this Ptsv2paymentsOrderInformationShipTo. - Name of the customer's company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Name of the customer's company. :return: The company of this Ptsv2paymentsOrderInformationShipTo. :rtype: str @@ -497,7 +497,7 @@ def company(self): def company(self, company): """ Sets the company of this Ptsv2paymentsOrderInformationShipTo. - Name of the customer's company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Name of the customer's company. :param company: The company of this Ptsv2paymentsOrderInformationShipTo. :type: str diff --git a/CyberSource/models/ptsv2payments_payment_information.py b/CyberSource/models/ptsv2payments_payment_information.py index 8dff2878..967660b1 100644 --- a/CyberSource/models/ptsv2payments_payment_information.py +++ b/CyberSource/models/ptsv2payments_payment_information.py @@ -44,7 +44,8 @@ class Ptsv2paymentsPaymentInformation(object): 'payment_type': 'Ptsv2paymentsPaymentInformationPaymentType', 'initiation_channel': 'str', 'sepa': 'Ptsv2paymentsPaymentInformationSepa', - 'e_wallet': 'Ptsv2paymentsPaymentInformationEWallet' + 'e_wallet': 'Ptsv2paymentsPaymentInformationEWallet', + 'payment_account_reference': 'Ptsv2paymentsPaymentInformationPaymentAccountReference' } attribute_map = { @@ -62,10 +63,11 @@ class Ptsv2paymentsPaymentInformation(object): 'payment_type': 'paymentType', 'initiation_channel': 'initiationChannel', 'sepa': 'sepa', - 'e_wallet': 'eWallet' + 'e_wallet': 'eWallet', + 'payment_account_reference': 'paymentAccountReference' } - def __init__(self, card=None, tokenized_card=None, direct_debit=None, fluid_data=None, customer=None, payment_instrument=None, instrument_identifier=None, shipping_address=None, legacy_token=None, bank=None, options=None, payment_type=None, initiation_channel=None, sepa=None, e_wallet=None): + def __init__(self, card=None, tokenized_card=None, direct_debit=None, fluid_data=None, customer=None, payment_instrument=None, instrument_identifier=None, shipping_address=None, legacy_token=None, bank=None, options=None, payment_type=None, initiation_channel=None, sepa=None, e_wallet=None, payment_account_reference=None): """ Ptsv2paymentsPaymentInformation - a model defined in Swagger """ @@ -85,6 +87,7 @@ def __init__(self, card=None, tokenized_card=None, direct_debit=None, fluid_data self._initiation_channel = None self._sepa = None self._e_wallet = None + self._payment_account_reference = None if card is not None: self.card = card @@ -116,6 +119,8 @@ def __init__(self, card=None, tokenized_card=None, direct_debit=None, fluid_data self.sepa = sepa if e_wallet is not None: self.e_wallet = e_wallet + if payment_account_reference is not None: + self.payment_account_reference = payment_account_reference @property def card(self): @@ -434,6 +439,27 @@ def e_wallet(self, e_wallet): self._e_wallet = e_wallet + @property + def payment_account_reference(self): + """ + Gets the payment_account_reference of this Ptsv2paymentsPaymentInformation. + + :return: The payment_account_reference of this Ptsv2paymentsPaymentInformation. + :rtype: Ptsv2paymentsPaymentInformationPaymentAccountReference + """ + return self._payment_account_reference + + @payment_account_reference.setter + def payment_account_reference(self, payment_account_reference): + """ + Sets the payment_account_reference of this Ptsv2paymentsPaymentInformation. + + :param payment_account_reference: The payment_account_reference of this Ptsv2paymentsPaymentInformation. + :type: Ptsv2paymentsPaymentInformationPaymentAccountReference + """ + + self._payment_account_reference = payment_account_reference + def to_dict(self): """ Returns the model properties as a dict diff --git a/CyberSource/models/ptsv2payments_payment_information_payment_account_reference.py b/CyberSource/models/ptsv2payments_payment_information_payment_account_reference.py new file mode 100644 index 00000000..048e0388 --- /dev/null +++ b/CyberSource/models/ptsv2payments_payment_information_payment_account_reference.py @@ -0,0 +1,124 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from pprint import pformat +from six import iteritems +import re + + +class Ptsv2paymentsPaymentInformationPaymentAccountReference(object): + """ + NOTE: This class is auto generated by the swagger code generator program. + Do not edit the class manually. + """ + + + """ + Attributes: + swagger_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + swagger_types = { + 'id': 'str' + } + + attribute_map = { + 'id': 'id' + } + + def __init__(self, id=None): + """ + Ptsv2paymentsPaymentInformationPaymentAccountReference - a model defined in Swagger + """ + + self._id = None + + if id is not None: + self.id = id + + @property + def id(self): + """ + Gets the id of this Ptsv2paymentsPaymentInformationPaymentAccountReference. + A Payment Account Reference number (PAR) is a unique reference value associated with a specific card holder PAN. It identifies the card account, not just a card. PAR is a non-payment identifier that can be associated to PANs and tokens, as defined by EMVCo. PAR allows all participants in the payments chain to have a single, non-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder identification fields, and transmitted across the payments ecosystem to facilitate card holder identification. PAR has a well-defined format (as per the Jan 2016 EMVCo documentation): + + :return: The id of this Ptsv2paymentsPaymentInformationPaymentAccountReference. + :rtype: str + """ + return self._id + + @id.setter + def id(self, id): + """ + Sets the id of this Ptsv2paymentsPaymentInformationPaymentAccountReference. + A Payment Account Reference number (PAR) is a unique reference value associated with a specific card holder PAN. It identifies the card account, not just a card. PAR is a non-payment identifier that can be associated to PANs and tokens, as defined by EMVCo. PAR allows all participants in the payments chain to have a single, non-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder identification fields, and transmitted across the payments ecosystem to facilitate card holder identification. PAR has a well-defined format (as per the Jan 2016 EMVCo documentation): + + :param id: The id of this Ptsv2paymentsPaymentInformationPaymentAccountReference. + :type: str + """ + + self._id = id + + def to_dict(self): + """ + Returns the model properties as a dict + """ + result = {} + + for attr, _ in iteritems(self.swagger_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """ + Returns the string representation of the model + """ + return pformat(self.to_dict()) + + def __repr__(self): + """ + For `print` and `pprint` + """ + return self.to_str() + + def __eq__(self, other): + """ + Returns true if both objects are equal + """ + if not isinstance(other, Ptsv2paymentsPaymentInformationPaymentAccountReference): + return False + + return self.__dict__ == other.__dict__ + + def __ne__(self, other): + """ + Returns true if both objects are not equal + """ + return not self == other diff --git a/CyberSource/models/ptsv2payments_payment_information_tokenized_card.py b/CyberSource/models/ptsv2payments_payment_information_tokenized_card.py index f7a9cd02..abbdb2ca 100644 --- a/CyberSource/models/ptsv2payments_payment_information_tokenized_card.py +++ b/CyberSource/models/ptsv2payments_payment_information_tokenized_card.py @@ -129,7 +129,7 @@ def number(self, number): def expiration_month(self): """ Gets the expiration_month of this Ptsv2paymentsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :return: The expiration_month of this Ptsv2paymentsPaymentInformationTokenizedCard. :rtype: str @@ -140,7 +140,7 @@ def expiration_month(self): def expiration_month(self, expiration_month): """ Sets the expiration_month of this Ptsv2paymentsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :param expiration_month: The expiration_month of this Ptsv2paymentsPaymentInformationTokenizedCard. :type: str @@ -152,7 +152,7 @@ def expiration_month(self, expiration_month): def expiration_year(self): """ Gets the expiration_year of this Ptsv2paymentsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :return: The expiration_year of this Ptsv2paymentsPaymentInformationTokenizedCard. :rtype: str @@ -163,7 +163,7 @@ def expiration_year(self): def expiration_year(self, expiration_year): """ Sets the expiration_year of this Ptsv2paymentsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :param expiration_year: The expiration_year of this Ptsv2paymentsPaymentInformationTokenizedCard. :type: str @@ -313,7 +313,7 @@ def storage_method(self, storage_method): def security_code(self): """ Gets the security_code of this Ptsv2paymentsPaymentInformationTokenizedCard. - Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. For details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. :return: The security_code of this Ptsv2paymentsPaymentInformationTokenizedCard. :rtype: str @@ -324,7 +324,7 @@ def security_code(self): def security_code(self, security_code): """ Sets the security_code of this Ptsv2paymentsPaymentInformationTokenizedCard. - Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. For details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. :param security_code: The security_code of this Ptsv2paymentsPaymentInformationTokenizedCard. :type: str diff --git a/CyberSource/models/ptsv2payments_point_of_sale_information.py b/CyberSource/models/ptsv2payments_point_of_sale_information.py index 233cce99..5942e45f 100644 --- a/CyberSource/models/ptsv2payments_point_of_sale_information.py +++ b/CyberSource/models/ptsv2payments_point_of_sale_information.py @@ -396,7 +396,7 @@ def emv(self, emv): def amex_capn_data(self): """ Gets the amex_capn_data of this Ptsv2paymentsPointOfSaleInformation. - Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. :return: The amex_capn_data of this Ptsv2paymentsPointOfSaleInformation. :rtype: str @@ -407,7 +407,7 @@ def amex_capn_data(self): def amex_capn_data(self, amex_capn_data): """ Sets the amex_capn_data of this Ptsv2paymentsPointOfSaleInformation. - Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. :param amex_capn_data: The amex_capn_data of this Ptsv2paymentsPointOfSaleInformation. :type: str diff --git a/CyberSource/models/ptsv2payments_processing_information.py b/CyberSource/models/ptsv2payments_processing_information.py index 0a5659d1..231a922e 100644 --- a/CyberSource/models/ptsv2payments_processing_information.py +++ b/CyberSource/models/ptsv2payments_processing_information.py @@ -45,7 +45,6 @@ class Ptsv2paymentsProcessingInformation(object): 'purchase_level': 'str', 'transaction_timeout': 'int', 'intents_id': 'str', - 'payment_id': 'str', 'report_group': 'str', 'visa_checkout_id': 'str', 'industry_data_type': 'str', @@ -66,7 +65,8 @@ class Ptsv2paymentsProcessingInformation(object): 'timeout': 'int', 'is_return_auth_record_enabled': 'bool', 'network_partner_id': 'str', - 'payment_type': 'str' + 'payment_type': 'str', + 'enabler_id': 'str' } attribute_map = { @@ -85,7 +85,6 @@ class Ptsv2paymentsProcessingInformation(object): 'purchase_level': 'purchaseLevel', 'transaction_timeout': 'transactionTimeout', 'intents_id': 'intentsId', - 'payment_id': 'paymentId', 'report_group': 'reportGroup', 'visa_checkout_id': 'visaCheckoutId', 'industry_data_type': 'industryDataType', @@ -106,10 +105,11 @@ class Ptsv2paymentsProcessingInformation(object): 'timeout': 'timeout', 'is_return_auth_record_enabled': 'isReturnAuthRecordEnabled', 'network_partner_id': 'networkPartnerId', - 'payment_type': 'paymentType' + 'payment_type': 'paymentType', + 'enabler_id': 'enablerId' } - def __init__(self, action_list=None, enable_escrow_option=None, action_token_types=None, bin_source=None, capture=False, processor_id=None, business_application_id=None, commerce_indicator=None, commerce_indicator_label=None, payment_solution=None, reconciliation_id=None, link_id=None, purchase_level=None, transaction_timeout=None, intents_id=None, payment_id=None, report_group=None, visa_checkout_id=None, industry_data_type=None, authorization_options=None, capture_options=None, recurring_options=None, bank_transfer_options=None, purchase_options=None, electronic_benefits_transfer=None, loan_options=None, wallet_type=None, national_net_domestic_data=None, japan_payment_options=None, mobile_remote_payment_type=None, extended_credit_total_count=None, network_routing_order=None, pay_by_points_indicator=None, timeout=None, is_return_auth_record_enabled=None, network_partner_id=None, payment_type=None): + def __init__(self, action_list=None, enable_escrow_option=None, action_token_types=None, bin_source=None, capture=False, processor_id=None, business_application_id=None, commerce_indicator=None, commerce_indicator_label=None, payment_solution=None, reconciliation_id=None, link_id=None, purchase_level=None, transaction_timeout=None, intents_id=None, report_group=None, visa_checkout_id=None, industry_data_type=None, authorization_options=None, capture_options=None, recurring_options=None, bank_transfer_options=None, purchase_options=None, electronic_benefits_transfer=None, loan_options=None, wallet_type=None, national_net_domestic_data=None, japan_payment_options=None, mobile_remote_payment_type=None, extended_credit_total_count=None, network_routing_order=None, pay_by_points_indicator=None, timeout=None, is_return_auth_record_enabled=None, network_partner_id=None, payment_type=None, enabler_id=None): """ Ptsv2paymentsProcessingInformation - a model defined in Swagger """ @@ -129,7 +129,6 @@ def __init__(self, action_list=None, enable_escrow_option=None, action_token_typ self._purchase_level = None self._transaction_timeout = None self._intents_id = None - self._payment_id = None self._report_group = None self._visa_checkout_id = None self._industry_data_type = None @@ -151,6 +150,7 @@ def __init__(self, action_list=None, enable_escrow_option=None, action_token_typ self._is_return_auth_record_enabled = None self._network_partner_id = None self._payment_type = None + self._enabler_id = None if action_list is not None: self.action_list = action_list @@ -182,8 +182,6 @@ def __init__(self, action_list=None, enable_escrow_option=None, action_token_typ self.transaction_timeout = transaction_timeout if intents_id is not None: self.intents_id = intents_id - if payment_id is not None: - self.payment_id = payment_id if report_group is not None: self.report_group = report_group if visa_checkout_id is not None: @@ -226,6 +224,8 @@ def __init__(self, action_list=None, enable_escrow_option=None, action_token_typ self.network_partner_id = network_partner_id if payment_type is not None: self.payment_type = payment_type + if enabler_id is not None: + self.enabler_id = enabler_id @property def action_list(self): @@ -438,7 +438,7 @@ def commerce_indicator_label(self, commerce_indicator_label): def payment_solution(self): """ Gets the payment_solution of this Ptsv2paymentsProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :return: The payment_solution of this Ptsv2paymentsProcessingInformation. :rtype: str @@ -449,7 +449,7 @@ def payment_solution(self): def payment_solution(self, payment_solution): """ Sets the payment_solution of this Ptsv2paymentsProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :param payment_solution: The payment_solution of this Ptsv2paymentsProcessingInformation. :type: str @@ -572,29 +572,6 @@ def intents_id(self, intents_id): self._intents_id = intents_id - @property - def payment_id(self): - """ - Gets the payment_id of this Ptsv2paymentsProcessingInformation. - This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream. - - :return: The payment_id of this Ptsv2paymentsProcessingInformation. - :rtype: str - """ - return self._payment_id - - @payment_id.setter - def payment_id(self, payment_id): - """ - Sets the payment_id of this Ptsv2paymentsProcessingInformation. - This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream. - - :param payment_id: The payment_id of this Ptsv2paymentsProcessingInformation. - :type: str - """ - - self._payment_id = payment_id - @property def report_group(self): """ @@ -1062,6 +1039,29 @@ def payment_type(self, payment_type): self._payment_type = payment_type + @property + def enabler_id(self): + """ + Gets the enabler_id of this Ptsv2paymentsProcessingInformation. + Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers. + + :return: The enabler_id of this Ptsv2paymentsProcessingInformation. + :rtype: str + """ + return self._enabler_id + + @enabler_id.setter + def enabler_id(self, enabler_id): + """ + Sets the enabler_id of this Ptsv2paymentsProcessingInformation. + Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers. + + :param enabler_id: The enabler_id of this Ptsv2paymentsProcessingInformation. + :type: str + """ + + self._enabler_id = enabler_id + def to_dict(self): """ Returns the model properties as a dict diff --git a/CyberSource/models/ptsv2payments_processing_information_loan_options.py b/CyberSource/models/ptsv2payments_processing_information_loan_options.py index 3c7cb4f9..e979f9a8 100644 --- a/CyberSource/models/ptsv2payments_processing_information_loan_options.py +++ b/CyberSource/models/ptsv2payments_processing_information_loan_options.py @@ -56,7 +56,7 @@ def __init__(self, type=None, asset_type=None): def type(self): """ Gets the type of this Ptsv2paymentsProcessingInformationLoanOptions. - Type of loan based on an agreement between you and the issuer. Examples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME. This field is supported only for these kinds of payments: - BNDES transactions on CyberSource through VisaNet. - Installment payments with Mastercard on CyberSource through VisaNet in Brazil. See \"\"Installment Payments on CyberSource through VisaNet,\"\" in the SCMP/SO guide For BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR2, Position: 27-46, Field: Loan Type For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR4, Position: 5-24,Field: Financing Type + Type of loan based on an agreement between you and the issuer. Examples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME. This field is supported only for these kinds of payments: - BNDES transactions on CyberSource through VisaNet. - Installment payments with Mastercard on CyberSource through VisaNet in Brazil. For BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR2, Position: 27-46, Field: Loan Type For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR4, Position: 5-24,Field: Financing Type :return: The type of this Ptsv2paymentsProcessingInformationLoanOptions. :rtype: str @@ -67,7 +67,7 @@ def type(self): def type(self, type): """ Sets the type of this Ptsv2paymentsProcessingInformationLoanOptions. - Type of loan based on an agreement between you and the issuer. Examples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME. This field is supported only for these kinds of payments: - BNDES transactions on CyberSource through VisaNet. - Installment payments with Mastercard on CyberSource through VisaNet in Brazil. See \"\"Installment Payments on CyberSource through VisaNet,\"\" in the SCMP/SO guide For BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR2, Position: 27-46, Field: Loan Type For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR4, Position: 5-24,Field: Financing Type + Type of loan based on an agreement between you and the issuer. Examples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME. This field is supported only for these kinds of payments: - BNDES transactions on CyberSource through VisaNet. - Installment payments with Mastercard on CyberSource through VisaNet in Brazil. For BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR2, Position: 27-46, Field: Loan Type For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR4, Position: 5-24,Field: Financing Type :param type: The type of this Ptsv2paymentsProcessingInformationLoanOptions. :type: str diff --git a/CyberSource/models/ptsv2payments_processing_information_recurring_options.py b/CyberSource/models/ptsv2payments_processing_information_recurring_options.py index a9a263c9..4b7c479f 100644 --- a/CyberSource/models/ptsv2payments_processing_information_recurring_options.py +++ b/CyberSource/models/ptsv2payments_processing_information_recurring_options.py @@ -56,7 +56,7 @@ def __init__(self, loan_payment=False, first_recurring_payment=False): def loan_payment(self): """ Gets the loan_payment of this Ptsv2paymentsProcessingInformationRecurringOptions. - Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment For processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment :return: The loan_payment of this Ptsv2paymentsProcessingInformationRecurringOptions. :rtype: bool @@ -67,7 +67,7 @@ def loan_payment(self): def loan_payment(self, loan_payment): """ Sets the loan_payment of this Ptsv2paymentsProcessingInformationRecurringOptions. - Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment For processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment :param loan_payment: The loan_payment of this Ptsv2paymentsProcessingInformationRecurringOptions. :type: bool @@ -79,7 +79,7 @@ def loan_payment(self, loan_payment): def first_recurring_payment(self): """ Gets the first_recurring_payment of this Ptsv2paymentsProcessingInformationRecurringOptions. - Flag that indicates whether this transaction is the first in a series of recurring payments. This field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**. Possible values: - `true` Indicates this is the first payment in a series of recurring payments - `false` (default) Indicates this is not the first payment in a series of recurring payments. For details, see `auth_first_recurring_payment` field description and \"Recurring Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Flag that indicates whether this transaction is the first in a series of recurring payments. This field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**. Possible values: - `true` Indicates this is the first payment in a series of recurring payments - `false` (default) Indicates this is not the first payment in a series of recurring payments. :return: The first_recurring_payment of this Ptsv2paymentsProcessingInformationRecurringOptions. :rtype: bool @@ -90,7 +90,7 @@ def first_recurring_payment(self): def first_recurring_payment(self, first_recurring_payment): """ Sets the first_recurring_payment of this Ptsv2paymentsProcessingInformationRecurringOptions. - Flag that indicates whether this transaction is the first in a series of recurring payments. This field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**. Possible values: - `true` Indicates this is the first payment in a series of recurring payments - `false` (default) Indicates this is not the first payment in a series of recurring payments. For details, see `auth_first_recurring_payment` field description and \"Recurring Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Flag that indicates whether this transaction is the first in a series of recurring payments. This field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**. Possible values: - `true` Indicates this is the first payment in a series of recurring payments - `false` (default) Indicates this is not the first payment in a series of recurring payments. :param first_recurring_payment: The first_recurring_payment of this Ptsv2paymentsProcessingInformationRecurringOptions. :type: bool diff --git a/CyberSource/models/ptsv2payments_recipient_information.py b/CyberSource/models/ptsv2payments_recipient_information.py index 2c1d5169..200530ba 100644 --- a/CyberSource/models/ptsv2payments_recipient_information.py +++ b/CyberSource/models/ptsv2payments_recipient_information.py @@ -86,7 +86,7 @@ def __init__(self, account_id=None, last_name=None, middle_name=None, postal_cod def account_id(self): """ Gets the account_id of this Ptsv2paymentsRecipientInformation. - Identifier for the recipient's account. Use the first six digits and last four digits of the recipient's account number. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_account_id` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Identifier for the recipient's account. Use the first six digits and last four digits of the recipient's account number. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipientInformation.accountId` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) :return: The account_id of this Ptsv2paymentsRecipientInformation. :rtype: str @@ -97,7 +97,7 @@ def account_id(self): def account_id(self, account_id): """ Sets the account_id of this Ptsv2paymentsRecipientInformation. - Identifier for the recipient's account. Use the first six digits and last four digits of the recipient's account number. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_account_id` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Identifier for the recipient's account. Use the first six digits and last four digits of the recipient's account number. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipientInformation.accountId` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) :param account_id: The account_id of this Ptsv2paymentsRecipientInformation. :type: str @@ -109,7 +109,7 @@ def account_id(self, account_id): def last_name(self): """ Gets the last_name of this Ptsv2paymentsRecipientInformation. - Recipient's last name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_lastname` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Recipient's last name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipientInformation.lastName` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) :return: The last_name of this Ptsv2paymentsRecipientInformation. :rtype: str @@ -120,7 +120,7 @@ def last_name(self): def last_name(self, last_name): """ Sets the last_name of this Ptsv2paymentsRecipientInformation. - Recipient's last name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_lastname` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Recipient's last name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipientInformation.lastName` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) :param last_name: The last_name of this Ptsv2paymentsRecipientInformation. :type: str @@ -132,7 +132,7 @@ def last_name(self, last_name): def middle_name(self): """ Gets the middle_name of this Ptsv2paymentsRecipientInformation. - Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_middlename` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipientInformation.middleName` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) :return: The middle_name of this Ptsv2paymentsRecipientInformation. :rtype: str @@ -143,7 +143,7 @@ def middle_name(self): def middle_name(self, middle_name): """ Sets the middle_name of this Ptsv2paymentsRecipientInformation. - Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_middlename` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipientInformation.middleName` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) :param middle_name: The middle_name of this Ptsv2paymentsRecipientInformation. :type: str @@ -155,7 +155,7 @@ def middle_name(self, middle_name): def postal_code(self): """ Gets the postal_code of this Ptsv2paymentsRecipientInformation. - Partial postal code for the recipient's address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_postal_code` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Partial postal code for the recipient's address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. :return: The postal_code of this Ptsv2paymentsRecipientInformation. :rtype: str @@ -166,7 +166,7 @@ def postal_code(self): def postal_code(self, postal_code): """ Sets the postal_code of this Ptsv2paymentsRecipientInformation. - Partial postal code for the recipient's address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_postal_code` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Partial postal code for the recipient's address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. :param postal_code: The postal_code of this Ptsv2paymentsRecipientInformation. :type: str @@ -178,7 +178,7 @@ def postal_code(self, postal_code): def date_of_birth(self): """ Gets the date_of_birth of this Ptsv2paymentsRecipientInformation. - Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. :return: The date_of_birth of this Ptsv2paymentsRecipientInformation. :rtype: str @@ -189,7 +189,7 @@ def date_of_birth(self): def date_of_birth(self, date_of_birth): """ Sets the date_of_birth of this Ptsv2paymentsRecipientInformation. - Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. :param date_of_birth: The date_of_birth of this Ptsv2paymentsRecipientInformation. :type: str diff --git a/CyberSource/models/ptsv2paymentsidcaptures_aggregator_information_sub_merchant.py b/CyberSource/models/ptsv2paymentsidcaptures_aggregator_information_sub_merchant.py index bc746fb0..e5edacc4 100644 --- a/CyberSource/models/ptsv2paymentsidcaptures_aggregator_information_sub_merchant.py +++ b/CyberSource/models/ptsv2paymentsidcaptures_aggregator_information_sub_merchant.py @@ -114,7 +114,7 @@ def name(self, name): def address1(self): """ Gets the address1 of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. - First line of the sub-merchant's street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + First line of the sub-merchant's street address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :return: The address1 of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. :rtype: str @@ -125,7 +125,7 @@ def address1(self): def address1(self, address1): """ Sets the address1 of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. - First line of the sub-merchant's street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + First line of the sub-merchant's street address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :param address1: The address1 of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. :type: str @@ -137,7 +137,7 @@ def address1(self, address1): def locality(self): """ Gets the locality of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. - Sub-merchant's city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Sub-merchant's city. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :return: The locality of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. :rtype: str @@ -148,7 +148,7 @@ def locality(self): def locality(self, locality): """ Sets the locality of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. - Sub-merchant's city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Sub-merchant's city. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :param locality: The locality of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. :type: str @@ -160,7 +160,7 @@ def locality(self, locality): def administrative_area(self): """ Gets the administrative_area of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. - Sub-merchant's state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Sub-merchant's state or province. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :return: The administrative_area of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. :rtype: str @@ -171,7 +171,7 @@ def administrative_area(self): def administrative_area(self, administrative_area): """ Sets the administrative_area of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. - Sub-merchant's state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Sub-merchant's state or province. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :param administrative_area: The administrative_area of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. :type: str @@ -183,7 +183,7 @@ def administrative_area(self, administrative_area): def postal_code(self): """ Gets the postal_code of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. - Partial postal code for the sub-merchant's address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Partial postal code for the sub-merchant's address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :return: The postal_code of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. :rtype: str @@ -194,7 +194,7 @@ def postal_code(self): def postal_code(self, postal_code): """ Sets the postal_code of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. - Partial postal code for the sub-merchant's address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + Partial postal code for the sub-merchant's address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. :param postal_code: The postal_code of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. :type: str @@ -206,7 +206,7 @@ def postal_code(self, postal_code): def country(self): """ Gets the country of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. - Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. For details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. :return: The country of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. :rtype: str @@ -217,7 +217,7 @@ def country(self): def country(self, country): """ Sets the country of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. - Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. For details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. :param country: The country of this Ptsv2paymentsidcapturesAggregatorInformationSubMerchant. :type: str diff --git a/CyberSource/models/ptsv2paymentsidcaptures_installment_information.py b/CyberSource/models/ptsv2paymentsidcaptures_installment_information.py index dfb4fa83..d1714217 100644 --- a/CyberSource/models/ptsv2paymentsidcaptures_installment_information.py +++ b/CyberSource/models/ptsv2paymentsidcaptures_installment_information.py @@ -171,7 +171,7 @@ def __init__(self, amount=None, frequency=None, plan_type=None, sequence=None, t def amount(self): """ Gets the amount of this Ptsv2paymentsidcapturesInstallmentInformation. - Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. :return: The amount of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -182,7 +182,7 @@ def amount(self): def amount(self, amount): """ Sets the amount of this Ptsv2paymentsidcapturesInstallmentInformation. - Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. :param amount: The amount of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -194,7 +194,7 @@ def amount(self, amount): def frequency(self): """ Gets the frequency of this Ptsv2paymentsidcapturesInstallmentInformation. - Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency :return: The frequency of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -205,7 +205,7 @@ def frequency(self): def frequency(self, frequency): """ Sets the frequency of this Ptsv2paymentsidcapturesInstallmentInformation. - Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency :param frequency: The frequency of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -217,7 +217,7 @@ def frequency(self, frequency): def plan_type(self): """ Gets the plan_type of this Ptsv2paymentsidcapturesInstallmentInformation. - #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) + #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) :return: The plan_type of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -228,7 +228,7 @@ def plan_type(self): def plan_type(self, plan_type): """ Sets the plan_type of this Ptsv2paymentsidcapturesInstallmentInformation. - #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) + #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) :param plan_type: The plan_type of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -240,7 +240,7 @@ def plan_type(self, plan_type): def sequence(self): """ Gets the sequence of this Ptsv2paymentsidcapturesInstallmentInformation. - Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :return: The sequence of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: int @@ -251,7 +251,7 @@ def sequence(self): def sequence(self, sequence): """ Sets the sequence of this Ptsv2paymentsidcapturesInstallmentInformation. - Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :param sequence: The sequence of this Ptsv2paymentsidcapturesInstallmentInformation. :type: int @@ -263,7 +263,7 @@ def sequence(self, sequence): def total_amount(self): """ Gets the total_amount of this Ptsv2paymentsidcapturesInstallmentInformation. - Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. :return: The total_amount of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -274,7 +274,7 @@ def total_amount(self): def total_amount(self, total_amount): """ Sets the total_amount of this Ptsv2paymentsidcapturesInstallmentInformation. - Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. :param total_amount: The total_amount of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -286,7 +286,7 @@ def total_amount(self, total_amount): def total_count(self): """ Gets the total_count of this Ptsv2paymentsidcapturesInstallmentInformation. - Total number of installments when making payments in installments. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :return: The total_count of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: int @@ -297,7 +297,7 @@ def total_count(self): def total_count(self, total_count): """ Sets the total_count of this Ptsv2paymentsidcapturesInstallmentInformation. - Total number of installments when making payments in installments. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. :param total_count: The total_count of this Ptsv2paymentsidcapturesInstallmentInformation. :type: int @@ -309,7 +309,7 @@ def total_count(self, total_count): def first_installment_date(self): """ Gets the first_installment_date of this Ptsv2paymentsidcapturesInstallmentInformation. - Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment + Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment :return: The first_installment_date of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -320,7 +320,7 @@ def first_installment_date(self): def first_installment_date(self, first_installment_date): """ Sets the first_installment_date of this Ptsv2paymentsidcapturesInstallmentInformation. - Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment + Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment :param first_installment_date: The first_installment_date of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -355,7 +355,7 @@ def first_installment_amount(self, first_installment_amount): def invoice_data(self): """ Gets the invoice_data of this Ptsv2paymentsidcapturesInstallmentInformation. - Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification + Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification :return: The invoice_data of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -366,7 +366,7 @@ def invoice_data(self): def invoice_data(self, invoice_data): """ Sets the invoice_data of this Ptsv2paymentsidcapturesInstallmentInformation. - Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification + Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification :param invoice_data: The invoice_data of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -378,7 +378,7 @@ def invoice_data(self, invoice_data): def payment_type(self): """ Gets the payment_type of this Ptsv2paymentsidcapturesInstallmentInformation. - Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information + Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information :return: The payment_type of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -389,7 +389,7 @@ def payment_type(self): def payment_type(self, payment_type): """ Sets the payment_type of this Ptsv2paymentsidcapturesInstallmentInformation. - Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information + Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information :param payment_type: The payment_type of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -401,7 +401,7 @@ def payment_type(self, payment_type): def additional_costs(self): """ Gets the additional_costs of this Ptsv2paymentsidcapturesInstallmentInformation. - Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs + Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs :return: The additional_costs of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -412,7 +412,7 @@ def additional_costs(self): def additional_costs(self, additional_costs): """ Sets the additional_costs of this Ptsv2paymentsidcapturesInstallmentInformation. - Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs + Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs :param additional_costs: The additional_costs of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -424,7 +424,7 @@ def additional_costs(self, additional_costs): def additional_costs_percentage(self): """ Gets the additional_costs_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs + Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs :return: The additional_costs_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -435,7 +435,7 @@ def additional_costs_percentage(self): def additional_costs_percentage(self, additional_costs_percentage): """ Sets the additional_costs_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs + Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs :param additional_costs_percentage: The additional_costs_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -447,7 +447,7 @@ def additional_costs_percentage(self, additional_costs_percentage): def amount_funded(self): """ Gets the amount_funded of this Ptsv2paymentsidcapturesInstallmentInformation. - Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded + Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded :return: The amount_funded of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -458,7 +458,7 @@ def amount_funded(self): def amount_funded(self, amount_funded): """ Sets the amount_funded of this Ptsv2paymentsidcapturesInstallmentInformation. - Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded + Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded :param amount_funded: The amount_funded of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -470,7 +470,7 @@ def amount_funded(self, amount_funded): def amount_requested_percentage(self): """ Gets the amount_requested_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested + Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested :return: The amount_requested_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -481,7 +481,7 @@ def amount_requested_percentage(self): def amount_requested_percentage(self, amount_requested_percentage): """ Sets the amount_requested_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested + Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested :param amount_requested_percentage: The amount_requested_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -493,7 +493,7 @@ def amount_requested_percentage(self, amount_requested_percentage): def annual_financing_cost(self): """ Gets the annual_financing_cost of this Ptsv2paymentsidcapturesInstallmentInformation. - Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing + Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing :return: The annual_financing_cost of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -504,7 +504,7 @@ def annual_financing_cost(self): def annual_financing_cost(self, annual_financing_cost): """ Sets the annual_financing_cost of this Ptsv2paymentsidcapturesInstallmentInformation. - Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing + Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing :param annual_financing_cost: The annual_financing_cost of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -516,7 +516,7 @@ def annual_financing_cost(self, annual_financing_cost): def annual_interest_rate(self): """ Gets the annual_interest_rate of this Ptsv2paymentsidcapturesInstallmentInformation. - Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate + Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate :return: The annual_interest_rate of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -527,7 +527,7 @@ def annual_interest_rate(self): def annual_interest_rate(self, annual_interest_rate): """ Sets the annual_interest_rate of this Ptsv2paymentsidcapturesInstallmentInformation. - Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate + Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate :param annual_interest_rate: The annual_interest_rate of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -539,7 +539,7 @@ def annual_interest_rate(self, annual_interest_rate): def expenses(self): """ Gets the expenses of this Ptsv2paymentsidcapturesInstallmentInformation. - Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses + Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses :return: The expenses of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -550,7 +550,7 @@ def expenses(self): def expenses(self, expenses): """ Sets the expenses of this Ptsv2paymentsidcapturesInstallmentInformation. - Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses + Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses :param expenses: The expenses of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -562,7 +562,7 @@ def expenses(self, expenses): def expenses_percentage(self): """ Gets the expenses_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses + Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses :return: The expenses_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -573,7 +573,7 @@ def expenses_percentage(self): def expenses_percentage(self, expenses_percentage): """ Sets the expenses_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses + Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses :param expenses_percentage: The expenses_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -585,7 +585,7 @@ def expenses_percentage(self, expenses_percentage): def fees(self): """ Gets the fees of this Ptsv2paymentsidcapturesInstallmentInformation. - Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees + Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees :return: The fees of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -596,7 +596,7 @@ def fees(self): def fees(self, fees): """ Sets the fees of this Ptsv2paymentsidcapturesInstallmentInformation. - Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees + Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees :param fees: The fees of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -608,7 +608,7 @@ def fees(self, fees): def fees_percentage(self): """ Gets the fees_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees + Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees :return: The fees_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -619,7 +619,7 @@ def fees_percentage(self): def fees_percentage(self, fees_percentage): """ Sets the fees_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees + Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees :param fees_percentage: The fees_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -631,7 +631,7 @@ def fees_percentage(self, fees_percentage): def insurance(self): """ Gets the insurance of this Ptsv2paymentsidcapturesInstallmentInformation. - Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance + Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance :return: The insurance of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -642,7 +642,7 @@ def insurance(self): def insurance(self, insurance): """ Sets the insurance of this Ptsv2paymentsidcapturesInstallmentInformation. - Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance + Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance :param insurance: The insurance of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -654,7 +654,7 @@ def insurance(self, insurance): def insurance_percentage(self): """ Gets the insurance_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance + Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance :return: The insurance_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -665,7 +665,7 @@ def insurance_percentage(self): def insurance_percentage(self, insurance_percentage): """ Sets the insurance_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance + Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance :param insurance_percentage: The insurance_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -677,7 +677,7 @@ def insurance_percentage(self, insurance_percentage): def monthly_interest_rate(self): """ Gets the monthly_interest_rate of this Ptsv2paymentsidcapturesInstallmentInformation. - Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate + Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate :return: The monthly_interest_rate of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -688,7 +688,7 @@ def monthly_interest_rate(self): def monthly_interest_rate(self, monthly_interest_rate): """ Sets the monthly_interest_rate of this Ptsv2paymentsidcapturesInstallmentInformation. - Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate + Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate :param monthly_interest_rate: The monthly_interest_rate of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -700,7 +700,7 @@ def monthly_interest_rate(self, monthly_interest_rate): def taxes(self): """ Gets the taxes of this Ptsv2paymentsidcapturesInstallmentInformation. - Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes + Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes :return: The taxes of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -711,7 +711,7 @@ def taxes(self): def taxes(self, taxes): """ Sets the taxes of this Ptsv2paymentsidcapturesInstallmentInformation. - Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes + Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes :param taxes: The taxes of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str @@ -723,7 +723,7 @@ def taxes(self, taxes): def taxes_percentage(self): """ Gets the taxes_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes + Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes :return: The taxes_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :rtype: str @@ -734,7 +734,7 @@ def taxes_percentage(self): def taxes_percentage(self, taxes_percentage): """ Sets the taxes_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. - Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes + Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes :param taxes_percentage: The taxes_percentage of this Ptsv2paymentsidcapturesInstallmentInformation. :type: str diff --git a/CyberSource/models/ptsv2paymentsidcaptures_merchant_information.py b/CyberSource/models/ptsv2paymentsidcaptures_merchant_information.py index 79d42a2a..782d2591 100644 --- a/CyberSource/models/ptsv2paymentsidcaptures_merchant_information.py +++ b/CyberSource/models/ptsv2paymentsidcaptures_merchant_information.py @@ -97,7 +97,7 @@ def merchant_descriptor(self, merchant_descriptor): def card_acceptor_reference_number(self): """ Gets the card_acceptor_reference_number of this Ptsv2paymentsidcapturesMerchantInformation. - Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description 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) + Reference number that facilitates card acceptor/corporation communication and record keeping. :return: The card_acceptor_reference_number of this Ptsv2paymentsidcapturesMerchantInformation. :rtype: str @@ -108,7 +108,7 @@ def card_acceptor_reference_number(self): def card_acceptor_reference_number(self, card_acceptor_reference_number): """ Sets the card_acceptor_reference_number of this Ptsv2paymentsidcapturesMerchantInformation. - Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description 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) + Reference number that facilitates card acceptor/corporation communication and record keeping. :param card_acceptor_reference_number: The card_acceptor_reference_number of this Ptsv2paymentsidcapturesMerchantInformation. :type: str @@ -120,7 +120,7 @@ def card_acceptor_reference_number(self, card_acceptor_reference_number): def category_code(self): """ Gets the category_code of this Ptsv2paymentsidcapturesMerchantInformation. - The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code + The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code :return: The category_code of this Ptsv2paymentsidcapturesMerchantInformation. :rtype: int @@ -131,7 +131,7 @@ def category_code(self): def category_code(self, category_code): """ Sets the category_code of this Ptsv2paymentsidcapturesMerchantInformation. - The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code + The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code :param category_code: The category_code of this Ptsv2paymentsidcapturesMerchantInformation. :type: int @@ -143,7 +143,7 @@ def category_code(self, category_code): def vat_registration_number(self): """ Gets the vat_registration_number of this Ptsv2paymentsidcapturesMerchantInformation. - Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description 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) + Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. :return: The vat_registration_number of this Ptsv2paymentsidcapturesMerchantInformation. :rtype: str @@ -154,7 +154,7 @@ def vat_registration_number(self): def vat_registration_number(self, vat_registration_number): """ Sets the vat_registration_number of this Ptsv2paymentsidcapturesMerchantInformation. - Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description 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) + Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. :param vat_registration_number: The vat_registration_number of this Ptsv2paymentsidcapturesMerchantInformation. :type: str @@ -187,7 +187,7 @@ def service_fee_descriptor(self, service_fee_descriptor): def tax_id(self): """ Gets the tax_id of this Ptsv2paymentsidcapturesMerchantInformation. - Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 :return: The tax_id of this Ptsv2paymentsidcapturesMerchantInformation. :rtype: str @@ -198,7 +198,7 @@ def tax_id(self): def tax_id(self, tax_id): """ Sets the tax_id of this Ptsv2paymentsidcapturesMerchantInformation. - Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 :param tax_id: The tax_id of this Ptsv2paymentsidcapturesMerchantInformation. :type: str diff --git a/CyberSource/models/ptsv2paymentsidcaptures_order_information_invoice_details.py b/CyberSource/models/ptsv2paymentsidcaptures_order_information_invoice_details.py index 5c0e7c38..af1a72d2 100644 --- a/CyberSource/models/ptsv2paymentsidcaptures_order_information_invoice_details.py +++ b/CyberSource/models/ptsv2paymentsidcaptures_order_information_invoice_details.py @@ -81,7 +81,7 @@ def __init__(self, purchase_order_number=None, purchase_order_date=None, purchas def purchase_order_number(self): """ Gets the purchase_order_number of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the `user_po` 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) + Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. :return: The purchase_order_number of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :rtype: str @@ -92,7 +92,7 @@ def purchase_order_number(self): def purchase_order_number(self, purchase_order_number): """ Sets the purchase_order_number of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the `user_po` 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) + Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. :param purchase_order_number: The purchase_order_number of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :type: str @@ -104,7 +104,7 @@ def purchase_order_number(self, purchase_order_number): def purchase_order_date(self): """ Gets the purchase_order_date of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the `purchaser_order_date` 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) + Date the order was processed. `Format: YYYY-MM-DD`. :return: The purchase_order_date of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :rtype: str @@ -115,7 +115,7 @@ def purchase_order_date(self): def purchase_order_date(self, purchase_order_date): """ Sets the purchase_order_date of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the `purchaser_order_date` 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) + Date the order was processed. `Format: YYYY-MM-DD`. :param purchase_order_date: The purchase_order_date of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :type: str @@ -127,7 +127,7 @@ def purchase_order_date(self, purchase_order_date): def purchase_contact_name(self): """ Gets the purchase_contact_name of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the `authorized_contact_name` 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) + The name of the individual or the company contacted for company authorized purchases. :return: The purchase_contact_name of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :rtype: str @@ -138,7 +138,7 @@ def purchase_contact_name(self): def purchase_contact_name(self, purchase_contact_name): """ Sets the purchase_contact_name of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the `authorized_contact_name` 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) + The name of the individual or the company contacted for company authorized purchases. :param purchase_contact_name: The purchase_contact_name of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :type: str @@ -150,7 +150,7 @@ def purchase_contact_name(self, purchase_contact_name): def taxable(self): """ Gets the taxable of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - 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** + 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. Possible values: - **true** - **false** :return: The taxable of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :rtype: bool @@ -161,7 +161,7 @@ def taxable(self): def taxable(self, taxable): """ Sets the taxable of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - 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** + 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. Possible values: - **true** - **false** :param taxable: The taxable of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :type: bool @@ -173,7 +173,7 @@ def taxable(self, taxable): def vat_invoice_reference_number(self): """ Gets the vat_invoice_reference_number of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - VAT invoice number associated with the transaction. For processor-specific information, see the `vat_invoice_ref_number` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + VAT invoice number associated with the transaction. :return: The vat_invoice_reference_number of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :rtype: str @@ -184,7 +184,7 @@ def vat_invoice_reference_number(self): def vat_invoice_reference_number(self, vat_invoice_reference_number): """ Sets the vat_invoice_reference_number of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - VAT invoice number associated with the transaction. For processor-specific information, see the `vat_invoice_ref_number` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) + VAT invoice number associated with the transaction. :param vat_invoice_reference_number: The vat_invoice_reference_number of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :type: str @@ -196,7 +196,7 @@ def vat_invoice_reference_number(self, vat_invoice_reference_number): def commodity_code(self): """ Gets the commodity_code of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the `summary_commodity_code` 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) + International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. :return: The commodity_code of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :rtype: str @@ -207,7 +207,7 @@ def commodity_code(self): def commodity_code(self, commodity_code): """ Sets the commodity_code of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. - International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the `summary_commodity_code` 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) + International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. :param commodity_code: The commodity_code of this Ptsv2paymentsidcapturesOrderInformationInvoiceDetails. :type: str diff --git a/CyberSource/models/ptsv2paymentsidcaptures_point_of_sale_information.py b/CyberSource/models/ptsv2paymentsidcaptures_point_of_sale_information.py index bee1b918..f3806470 100644 --- a/CyberSource/models/ptsv2paymentsidcaptures_point_of_sale_information.py +++ b/CyberSource/models/ptsv2paymentsidcaptures_point_of_sale_information.py @@ -77,7 +77,7 @@ def emv(self, emv): def amex_capn_data(self): """ Gets the amex_capn_data of this Ptsv2paymentsidcapturesPointOfSaleInformation. - Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. :return: The amex_capn_data of this Ptsv2paymentsidcapturesPointOfSaleInformation. :rtype: str @@ -88,7 +88,7 @@ def amex_capn_data(self): def amex_capn_data(self, amex_capn_data): """ Sets the amex_capn_data of this Ptsv2paymentsidcapturesPointOfSaleInformation. - Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. :param amex_capn_data: The amex_capn_data of this Ptsv2paymentsidcapturesPointOfSaleInformation. :type: str diff --git a/CyberSource/models/ptsv2paymentsidcaptures_processing_information.py b/CyberSource/models/ptsv2paymentsidcaptures_processing_information.py index 68cdd65b..af998fd1 100644 --- a/CyberSource/models/ptsv2paymentsidcaptures_processing_information.py +++ b/CyberSource/models/ptsv2paymentsidcaptures_processing_information.py @@ -111,7 +111,7 @@ def __init__(self, payment_solution=None, reconciliation_id=None, link_id=None, def payment_solution(self): """ Gets the payment_solution of this Ptsv2paymentsidcapturesProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :return: The payment_solution of this Ptsv2paymentsidcapturesProcessingInformation. :rtype: str @@ -122,7 +122,7 @@ def payment_solution(self): def payment_solution(self, payment_solution): """ Sets the payment_solution of this Ptsv2paymentsidcapturesProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :param payment_solution: The payment_solution of this Ptsv2paymentsidcapturesProcessingInformation. :type: str diff --git a/CyberSource/models/ptsv2paymentsidrefunds_merchant_information.py b/CyberSource/models/ptsv2paymentsidrefunds_merchant_information.py index 70fc7164..63c83e32 100644 --- a/CyberSource/models/ptsv2paymentsidrefunds_merchant_information.py +++ b/CyberSource/models/ptsv2paymentsidrefunds_merchant_information.py @@ -92,7 +92,7 @@ def merchant_descriptor(self, merchant_descriptor): def category_code(self): """ Gets the category_code of this Ptsv2paymentsidrefundsMerchantInformation. - The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code + The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code :return: The category_code of this Ptsv2paymentsidrefundsMerchantInformation. :rtype: int @@ -103,7 +103,7 @@ def category_code(self): def category_code(self, category_code): """ Sets the category_code of this Ptsv2paymentsidrefundsMerchantInformation. - The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code + The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code :param category_code: The category_code of this Ptsv2paymentsidrefundsMerchantInformation. :type: int @@ -115,7 +115,7 @@ def category_code(self, category_code): def vat_registration_number(self): """ Gets the vat_registration_number of this Ptsv2paymentsidrefundsMerchantInformation. - Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description 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) + Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. :return: The vat_registration_number of this Ptsv2paymentsidrefundsMerchantInformation. :rtype: str @@ -126,7 +126,7 @@ def vat_registration_number(self): def vat_registration_number(self, vat_registration_number): """ Sets the vat_registration_number of this Ptsv2paymentsidrefundsMerchantInformation. - Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description 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) + Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. :param vat_registration_number: The vat_registration_number of this Ptsv2paymentsidrefundsMerchantInformation. :type: str @@ -138,7 +138,7 @@ def vat_registration_number(self, vat_registration_number): def card_acceptor_reference_number(self): """ Gets the card_acceptor_reference_number of this Ptsv2paymentsidrefundsMerchantInformation. - Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description 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) + Reference number that facilitates card acceptor/corporation communication and record keeping. :return: The card_acceptor_reference_number of this Ptsv2paymentsidrefundsMerchantInformation. :rtype: str @@ -149,7 +149,7 @@ def card_acceptor_reference_number(self): def card_acceptor_reference_number(self, card_acceptor_reference_number): """ Sets the card_acceptor_reference_number of this Ptsv2paymentsidrefundsMerchantInformation. - Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description 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) + Reference number that facilitates card acceptor/corporation communication and record keeping. :param card_acceptor_reference_number: The card_acceptor_reference_number of this Ptsv2paymentsidrefundsMerchantInformation. :type: str @@ -161,7 +161,7 @@ def card_acceptor_reference_number(self, card_acceptor_reference_number): def tax_id(self): """ Gets the tax_id of this Ptsv2paymentsidrefundsMerchantInformation. - Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 :return: The tax_id of this Ptsv2paymentsidrefundsMerchantInformation. :rtype: str @@ -172,7 +172,7 @@ def tax_id(self): def tax_id(self, tax_id): """ Sets the tax_id of this Ptsv2paymentsidrefundsMerchantInformation. - Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 :param tax_id: The tax_id of this Ptsv2paymentsidrefundsMerchantInformation. :type: str diff --git a/CyberSource/models/ptsv2paymentsidrefunds_order_information_line_items.py b/CyberSource/models/ptsv2paymentsidrefunds_order_information_line_items.py index 3284531f..ec26bf4a 100644 --- a/CyberSource/models/ptsv2paymentsidrefunds_order_information_line_items.py +++ b/CyberSource/models/ptsv2paymentsidrefunds_order_information_line_items.py @@ -146,7 +146,7 @@ def __init__(self, product_code=None, product_name=None, product_sku=None, quant def product_code(self): """ Gets the product_code of this Ptsv2paymentsidrefundsOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :return: The product_code of this Ptsv2paymentsidrefundsOrderInformationLineItems. :rtype: str @@ -157,7 +157,7 @@ def product_code(self): def product_code(self, product_code): """ Sets the product_code of this Ptsv2paymentsidrefundsOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :param product_code: The product_code of this Ptsv2paymentsidrefundsOrderInformationLineItems. :type: str @@ -238,7 +238,7 @@ def quantity(self, quantity): def unit_price(self): """ Gets the unit_price of this Ptsv2paymentsidrefundsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Ptsv2paymentsidrefundsOrderInformationLineItems. :rtype: str @@ -249,7 +249,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Ptsv2paymentsidrefundsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Ptsv2paymentsidrefundsOrderInformationLineItems. :type: str @@ -330,7 +330,7 @@ def tax_amount(self, tax_amount): def tax_rate(self): """ Gets the tax_rate of this Ptsv2paymentsidrefundsOrderInformationLineItems. - Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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%). + Tax rate applied to the item. **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%). :return: The tax_rate of this Ptsv2paymentsidrefundsOrderInformationLineItems. :rtype: str @@ -341,7 +341,7 @@ def tax_rate(self): def tax_rate(self, tax_rate): """ Sets the tax_rate of this Ptsv2paymentsidrefundsOrderInformationLineItems. - Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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%). + Tax rate applied to the item. **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%). :param tax_rate: The tax_rate of this Ptsv2paymentsidrefundsOrderInformationLineItems. :type: str @@ -399,7 +399,7 @@ def tax_status_indicator(self, tax_status_indicator): def tax_type_code(self): """ Gets the tax_type_code of this Ptsv2paymentsidrefundsOrderInformationLineItems. - Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` + Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` :return: The tax_type_code of this Ptsv2paymentsidrefundsOrderInformationLineItems. :rtype: str @@ -410,7 +410,7 @@ def tax_type_code(self): def tax_type_code(self, tax_type_code): """ Sets the tax_type_code of this Ptsv2paymentsidrefundsOrderInformationLineItems. - Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` + Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` :param tax_type_code: The tax_type_code of this Ptsv2paymentsidrefundsOrderInformationLineItems. :type: str diff --git a/CyberSource/models/ptsv2paymentsidrefunds_payment_information.py b/CyberSource/models/ptsv2paymentsidrefunds_payment_information.py index 83572bb7..e06c55f1 100644 --- a/CyberSource/models/ptsv2paymentsidrefunds_payment_information.py +++ b/CyberSource/models/ptsv2paymentsidrefunds_payment_information.py @@ -40,7 +40,8 @@ class Ptsv2paymentsidrefundsPaymentInformation(object): 'shipping_address': 'Ptsv2paymentsPaymentInformationShippingAddress', 'legacy_token': 'Ptsv2paymentsPaymentInformationLegacyToken', 'payment_type': 'Ptsv2paymentsidrefundsPaymentInformationPaymentType', - 'e_wallet': 'Ptsv2paymentsidrefundsPaymentInformationEWallet' + 'e_wallet': 'Ptsv2paymentsidrefundsPaymentInformationEWallet', + 'payment_account_reference': 'Ptsv2paymentsPaymentInformationPaymentAccountReference' } attribute_map = { @@ -54,10 +55,11 @@ class Ptsv2paymentsidrefundsPaymentInformation(object): 'shipping_address': 'shippingAddress', 'legacy_token': 'legacyToken', 'payment_type': 'paymentType', - 'e_wallet': 'eWallet' + 'e_wallet': 'eWallet', + 'payment_account_reference': 'paymentAccountReference' } - def __init__(self, card=None, bank=None, tokenized_card=None, fluid_data=None, customer=None, payment_instrument=None, instrument_identifier=None, shipping_address=None, legacy_token=None, payment_type=None, e_wallet=None): + def __init__(self, card=None, bank=None, tokenized_card=None, fluid_data=None, customer=None, payment_instrument=None, instrument_identifier=None, shipping_address=None, legacy_token=None, payment_type=None, e_wallet=None, payment_account_reference=None): """ Ptsv2paymentsidrefundsPaymentInformation - a model defined in Swagger """ @@ -73,6 +75,7 @@ def __init__(self, card=None, bank=None, tokenized_card=None, fluid_data=None, c self._legacy_token = None self._payment_type = None self._e_wallet = None + self._payment_account_reference = None if card is not None: self.card = card @@ -96,6 +99,8 @@ def __init__(self, card=None, bank=None, tokenized_card=None, fluid_data=None, c self.payment_type = payment_type if e_wallet is not None: self.e_wallet = e_wallet + if payment_account_reference is not None: + self.payment_account_reference = payment_account_reference @property def card(self): @@ -328,6 +333,27 @@ def e_wallet(self, e_wallet): self._e_wallet = e_wallet + @property + def payment_account_reference(self): + """ + Gets the payment_account_reference of this Ptsv2paymentsidrefundsPaymentInformation. + + :return: The payment_account_reference of this Ptsv2paymentsidrefundsPaymentInformation. + :rtype: Ptsv2paymentsPaymentInformationPaymentAccountReference + """ + return self._payment_account_reference + + @payment_account_reference.setter + def payment_account_reference(self, payment_account_reference): + """ + Sets the payment_account_reference of this Ptsv2paymentsidrefundsPaymentInformation. + + :param payment_account_reference: The payment_account_reference of this Ptsv2paymentsidrefundsPaymentInformation. + :type: Ptsv2paymentsPaymentInformationPaymentAccountReference + """ + + self._payment_account_reference = payment_account_reference + def to_dict(self): """ Returns the model properties as a dict diff --git a/CyberSource/models/ptsv2paymentsidrefunds_processing_information.py b/CyberSource/models/ptsv2paymentsidrefunds_processing_information.py index 9eefd90f..8614baac 100644 --- a/CyberSource/models/ptsv2paymentsidrefunds_processing_information.py +++ b/CyberSource/models/ptsv2paymentsidrefunds_processing_information.py @@ -124,7 +124,7 @@ def action_list(self, action_list): def payment_solution(self): """ Gets the payment_solution of this Ptsv2paymentsidrefundsProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :return: The payment_solution of this Ptsv2paymentsidrefundsProcessingInformation. :rtype: str @@ -135,7 +135,7 @@ def payment_solution(self): def payment_solution(self, payment_solution): """ Sets the payment_solution of this Ptsv2paymentsidrefundsProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :param payment_solution: The payment_solution of this Ptsv2paymentsidrefundsProcessingInformation. :type: str diff --git a/CyberSource/models/ptsv2paymentsidrefunds_processing_information_recurring_options.py b/CyberSource/models/ptsv2paymentsidrefunds_processing_information_recurring_options.py index 3cecea85..1d38df9b 100644 --- a/CyberSource/models/ptsv2paymentsidrefunds_processing_information_recurring_options.py +++ b/CyberSource/models/ptsv2paymentsidrefunds_processing_information_recurring_options.py @@ -51,7 +51,7 @@ def __init__(self, loan_payment=False): def loan_payment(self): """ Gets the loan_payment of this Ptsv2paymentsidrefundsProcessingInformationRecurringOptions. - Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment For processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment :return: The loan_payment of this Ptsv2paymentsidrefundsProcessingInformationRecurringOptions. :rtype: bool @@ -62,7 +62,7 @@ def loan_payment(self): def loan_payment(self, loan_payment): """ Sets the loan_payment of this Ptsv2paymentsidrefundsProcessingInformationRecurringOptions. - Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment For processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment :param loan_payment: The loan_payment of this Ptsv2paymentsidrefundsProcessingInformationRecurringOptions. :type: bool diff --git a/CyberSource/models/ptsv2paymentsidreversals_order_information_line_items.py b/CyberSource/models/ptsv2paymentsidreversals_order_information_line_items.py index 6ad059e5..691dfb58 100644 --- a/CyberSource/models/ptsv2paymentsidreversals_order_information_line_items.py +++ b/CyberSource/models/ptsv2paymentsidreversals_order_information_line_items.py @@ -79,7 +79,7 @@ def quantity(self, quantity): def unit_price(self): """ Gets the unit_price of this Ptsv2paymentsidreversalsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Ptsv2paymentsidreversalsOrderInformationLineItems. :rtype: str @@ -90,7 +90,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Ptsv2paymentsidreversalsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Ptsv2paymentsidreversalsOrderInformationLineItems. :type: str diff --git a/CyberSource/models/ptsv2paymentsidreversals_processing_information.py b/CyberSource/models/ptsv2paymentsidreversals_processing_information.py index 9def872e..11b6194e 100644 --- a/CyberSource/models/ptsv2paymentsidreversals_processing_information.py +++ b/CyberSource/models/ptsv2paymentsidreversals_processing_information.py @@ -81,7 +81,7 @@ def __init__(self, payment_solution=None, reconciliation_id=None, link_id=None, def payment_solution(self): """ Gets the payment_solution of this Ptsv2paymentsidreversalsProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :return: The payment_solution of this Ptsv2paymentsidreversalsProcessingInformation. :rtype: str @@ -92,7 +92,7 @@ def payment_solution(self): def payment_solution(self, payment_solution): """ Sets the payment_solution of this Ptsv2paymentsidreversalsProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :param payment_solution: The payment_solution of this Ptsv2paymentsidreversalsProcessingInformation. :type: str diff --git a/CyberSource/models/ptsv2payouts_merchant_information.py b/CyberSource/models/ptsv2payouts_merchant_information.py index 40fa5333..949abbd8 100644 --- a/CyberSource/models/ptsv2payouts_merchant_information.py +++ b/CyberSource/models/ptsv2payouts_merchant_information.py @@ -66,7 +66,7 @@ def __init__(self, category_code=None, submit_local_date_time=None, vat_registra def category_code(self): """ Gets the category_code of this Ptsv2payoutsMerchantInformation. - The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code + The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code :return: The category_code of this Ptsv2payoutsMerchantInformation. :rtype: int @@ -77,7 +77,7 @@ def category_code(self): def category_code(self, category_code): """ Sets the category_code of this Ptsv2payoutsMerchantInformation. - The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code + The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code :param category_code: The category_code of this Ptsv2payoutsMerchantInformation. :type: int @@ -112,7 +112,7 @@ def submit_local_date_time(self, submit_local_date_time): def vat_registration_number(self): """ Gets the vat_registration_number of this Ptsv2payoutsMerchantInformation. - Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description 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) + Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. :return: The vat_registration_number of this Ptsv2payoutsMerchantInformation. :rtype: str @@ -123,7 +123,7 @@ def vat_registration_number(self): def vat_registration_number(self, vat_registration_number): """ Sets the vat_registration_number of this Ptsv2payoutsMerchantInformation. - Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description 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) + Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. :param vat_registration_number: The vat_registration_number of this Ptsv2payoutsMerchantInformation. :type: str diff --git a/CyberSource/models/ptsv2payouts_merchant_information_merchant_descriptor.py b/CyberSource/models/ptsv2payouts_merchant_information_merchant_descriptor.py index 1e6f199a..515d943a 100644 --- a/CyberSource/models/ptsv2payouts_merchant_information_merchant_descriptor.py +++ b/CyberSource/models/ptsv2payouts_merchant_information_merchant_descriptor.py @@ -196,7 +196,7 @@ def postal_code(self, postal_code): def contact(self): """ Gets the contact of this Ptsv2payoutsMerchantInformationMerchantDescriptor. - For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) + Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) :return: The contact of this Ptsv2payoutsMerchantInformationMerchantDescriptor. :rtype: str @@ -207,7 +207,7 @@ def contact(self): def contact(self, contact): """ Sets the contact of this Ptsv2payoutsMerchantInformationMerchantDescriptor. - For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) + Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) :param contact: The contact of this Ptsv2payoutsMerchantInformationMerchantDescriptor. :type: str @@ -219,7 +219,7 @@ def contact(self, contact): def address1(self): """ Gets the address1 of this Ptsv2payoutsMerchantInformationMerchantDescriptor. - First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + First line of merchant's address. :return: The address1 of this Ptsv2payoutsMerchantInformationMerchantDescriptor. :rtype: str @@ -230,7 +230,7 @@ def address1(self): def address1(self, address1): """ Sets the address1 of this Ptsv2payoutsMerchantInformationMerchantDescriptor. - First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + First line of merchant's address. :param address1: The address1 of this Ptsv2payoutsMerchantInformationMerchantDescriptor. :type: str diff --git a/CyberSource/models/ptsv2payouts_processing_information.py b/CyberSource/models/ptsv2payouts_processing_information.py index 8a13aa95..1379d9cb 100644 --- a/CyberSource/models/ptsv2payouts_processing_information.py +++ b/CyberSource/models/ptsv2payouts_processing_information.py @@ -109,7 +109,7 @@ def business_application_id(self, business_application_id): def network_routing_order(self): """ Gets the network_routing_order of this Ptsv2payoutsProcessingInformation. - This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. For details, see the `network_order` field description in [BIN Lookup Service Using the SCMP API.](http://apps.cybersource.com/library/documentation/BIN_Lookup/BIN_Lookup_SCMP_API/html/) + This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. :return: The network_routing_order of this Ptsv2payoutsProcessingInformation. :rtype: str @@ -120,7 +120,7 @@ def network_routing_order(self): def network_routing_order(self, network_routing_order): """ Sets the network_routing_order of this Ptsv2payoutsProcessingInformation. - This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. For details, see the `network_order` field description in [BIN Lookup Service Using the SCMP API.](http://apps.cybersource.com/library/documentation/BIN_Lookup/BIN_Lookup_SCMP_API/html/) + This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. :param network_routing_order: The network_routing_order of this Ptsv2payoutsProcessingInformation. :type: str @@ -132,7 +132,7 @@ def network_routing_order(self, network_routing_order): def commerce_indicator(self): """ Gets the commerce_indicator of this Ptsv2payoutsProcessingInformation. - Type of transaction. Value for an OCT transaction: - `internet` For details, see the `e_commerce_indicator` field description in [Payouts Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SCMP/html/) + Type of transaction. Value for an OCT transaction: - `internet` :return: The commerce_indicator of this Ptsv2payoutsProcessingInformation. :rtype: str @@ -143,7 +143,7 @@ def commerce_indicator(self): def commerce_indicator(self, commerce_indicator): """ Sets the commerce_indicator of this Ptsv2payoutsProcessingInformation. - Type of transaction. Value for an OCT transaction: - `internet` For details, see the `e_commerce_indicator` field description in [Payouts Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SCMP/html/) + Type of transaction. Value for an OCT transaction: - `internet` :param commerce_indicator: The commerce_indicator of this Ptsv2payoutsProcessingInformation. :type: str diff --git a/CyberSource/models/ptsv2voids_processing_information.py b/CyberSource/models/ptsv2voids_processing_information.py index a5b27640..ccba5e5f 100644 --- a/CyberSource/models/ptsv2voids_processing_information.py +++ b/CyberSource/models/ptsv2voids_processing_information.py @@ -30,7 +30,7 @@ class Ptsv2voidsProcessingInformation(object): and the value is json key in definition. """ swagger_types = { - 'payment_id': 'str' + 'payment_id': 'object' } attribute_map = { @@ -51,10 +51,10 @@ def __init__(self, payment_id=None): def payment_id(self): """ Gets the payment_id of this Ptsv2voidsProcessingInformation. - This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream. + This field is to accept the id of credit/capture in the body of the requests so the type of void can be identified and processed correctly. :return: The payment_id of this Ptsv2voidsProcessingInformation. - :rtype: str + :rtype: object """ return self._payment_id @@ -62,10 +62,10 @@ def payment_id(self): def payment_id(self, payment_id): """ Sets the payment_id of this Ptsv2voidsProcessingInformation. - This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream. + This field is to accept the id of credit/capture in the body of the requests so the type of void can be identified and processed correctly. :param payment_id: The payment_id of this Ptsv2voidsProcessingInformation. - :type: str + :type: object """ self._payment_id = payment_id diff --git a/CyberSource/models/risk_v1_authentication_results_post201_response_consumer_authentication_information.py b/CyberSource/models/risk_v1_authentication_results_post201_response_consumer_authentication_information.py index 64085e43..eef6afed 100644 --- a/CyberSource/models/risk_v1_authentication_results_post201_response_consumer_authentication_information.py +++ b/CyberSource/models/risk_v1_authentication_results_post201_response_consumer_authentication_information.py @@ -590,7 +590,7 @@ def sdk_transaction_id(self, sdk_transaction_id): def specification_version(self): """ Gets the specification_version of this RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation. - This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0. + This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 :return: The specification_version of this RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation. :rtype: str @@ -601,7 +601,7 @@ def specification_version(self): def specification_version(self, specification_version): """ Sets the specification_version of this RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation. - This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0. + This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 :param specification_version: The specification_version of this RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation. :type: str diff --git a/CyberSource/models/risk_v1_decisions_post201_response_consumer_authentication_information.py b/CyberSource/models/risk_v1_decisions_post201_response_consumer_authentication_information.py index 11c7db78..adab2d23 100644 --- a/CyberSource/models/risk_v1_decisions_post201_response_consumer_authentication_information.py +++ b/CyberSource/models/risk_v1_decisions_post201_response_consumer_authentication_information.py @@ -987,7 +987,7 @@ def signed_pares_status_reason(self, signed_pares_status_reason): def specification_version(self): """ Gets the specification_version of this RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation. - This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0. + This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 :return: The specification_version of this RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation. :rtype: str @@ -998,7 +998,7 @@ def specification_version(self): def specification_version(self, specification_version): """ Sets the specification_version of this RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation. - This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0. + This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 :param specification_version: The specification_version of this RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation. :type: str diff --git a/CyberSource/models/riskv1addressverifications_order_information_line_items.py b/CyberSource/models/riskv1addressverifications_order_information_line_items.py index 09d1bfd7..f8999b5c 100644 --- a/CyberSource/models/riskv1addressverifications_order_information_line_items.py +++ b/CyberSource/models/riskv1addressverifications_order_information_line_items.py @@ -75,7 +75,7 @@ def __init__(self, unit_price=None, quantity=None, product_sku=None, product_ris def unit_price(self): """ Gets the unit_price of this Riskv1addressverificationsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Riskv1addressverificationsOrderInformationLineItems. :rtype: str @@ -86,7 +86,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Riskv1addressverificationsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Riskv1addressverificationsOrderInformationLineItems. :type: str @@ -190,7 +190,7 @@ def product_name(self, product_name): def product_code(self): """ Gets the product_code of this Riskv1addressverificationsOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :return: The product_code of this Riskv1addressverificationsOrderInformationLineItems. :rtype: str @@ -201,7 +201,7 @@ def product_code(self): def product_code(self, product_code): """ Sets the product_code of this Riskv1addressverificationsOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :param product_code: The product_code of this Riskv1addressverificationsOrderInformationLineItems. :type: str diff --git a/CyberSource/models/riskv1authenticationresults_payment_information_tokenized_card.py b/CyberSource/models/riskv1authenticationresults_payment_information_tokenized_card.py index 0c813914..e9c72b0e 100644 --- a/CyberSource/models/riskv1authenticationresults_payment_information_tokenized_card.py +++ b/CyberSource/models/riskv1authenticationresults_payment_information_tokenized_card.py @@ -117,7 +117,7 @@ def type(self, type): def expiration_month(self): """ Gets the expiration_month of this Riskv1authenticationresultsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :return: The expiration_month of this Riskv1authenticationresultsPaymentInformationTokenizedCard. :rtype: str @@ -128,7 +128,7 @@ def expiration_month(self): def expiration_month(self, expiration_month): """ Sets the expiration_month of this Riskv1authenticationresultsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :param expiration_month: The expiration_month of this Riskv1authenticationresultsPaymentInformationTokenizedCard. :type: str @@ -140,7 +140,7 @@ def expiration_month(self, expiration_month): def expiration_year(self): """ Gets the expiration_year of this Riskv1authenticationresultsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :return: The expiration_year of this Riskv1authenticationresultsPaymentInformationTokenizedCard. :rtype: str @@ -151,7 +151,7 @@ def expiration_year(self): def expiration_year(self, expiration_year): """ Sets the expiration_year of this Riskv1authenticationresultsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :param expiration_year: The expiration_year of this Riskv1authenticationresultsPaymentInformationTokenizedCard. :type: str diff --git a/CyberSource/models/riskv1authentications_order_information_line_items.py b/CyberSource/models/riskv1authentications_order_information_line_items.py index 382caec4..80e8df89 100644 --- a/CyberSource/models/riskv1authentications_order_information_line_items.py +++ b/CyberSource/models/riskv1authentications_order_information_line_items.py @@ -168,7 +168,7 @@ def total_amount(self, total_amount): def unit_price(self): """ Gets the unit_price of this Riskv1authenticationsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Riskv1authenticationsOrderInformationLineItems. :rtype: str @@ -179,7 +179,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Riskv1authenticationsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Riskv1authenticationsOrderInformationLineItems. :type: str @@ -214,7 +214,7 @@ def quantity(self, quantity): def gift_card_currency(self): """ Gets the gift_card_currency of this Riskv1authenticationsOrderInformationLineItems. - When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) + When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) :return: The gift_card_currency of this Riskv1authenticationsOrderInformationLineItems. :rtype: int @@ -225,7 +225,7 @@ def gift_card_currency(self): def gift_card_currency(self, gift_card_currency): """ Sets the gift_card_currency of this Riskv1authenticationsOrderInformationLineItems. - When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) + When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) :param gift_card_currency: The gift_card_currency of this Riskv1authenticationsOrderInformationLineItems. :type: int diff --git a/CyberSource/models/riskv1authentications_payment_information_tokenized_card.py b/CyberSource/models/riskv1authentications_payment_information_tokenized_card.py index a3bb26f8..af39c130 100644 --- a/CyberSource/models/riskv1authentications_payment_information_tokenized_card.py +++ b/CyberSource/models/riskv1authentications_payment_information_tokenized_card.py @@ -120,7 +120,7 @@ def type(self, type): def expiration_month(self): """ Gets the expiration_month of this Riskv1authenticationsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :return: The expiration_month of this Riskv1authenticationsPaymentInformationTokenizedCard. :rtype: str @@ -131,7 +131,7 @@ def expiration_month(self): def expiration_month(self, expiration_month): """ Sets the expiration_month of this Riskv1authenticationsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :param expiration_month: The expiration_month of this Riskv1authenticationsPaymentInformationTokenizedCard. :type: str @@ -143,7 +143,7 @@ def expiration_month(self, expiration_month): def expiration_year(self): """ Gets the expiration_year of this Riskv1authenticationsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :return: The expiration_year of this Riskv1authenticationsPaymentInformationTokenizedCard. :rtype: str @@ -154,7 +154,7 @@ def expiration_year(self): def expiration_year(self, expiration_year): """ Sets the expiration_year of this Riskv1authenticationsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :param expiration_year: The expiration_year of this Riskv1authenticationsPaymentInformationTokenizedCard. :type: str @@ -189,7 +189,7 @@ def cryptogram(self, cryptogram): def security_code(self): """ Gets the security_code of this Riskv1authenticationsPaymentInformationTokenizedCard. - Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. For details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. :return: The security_code of this Riskv1authenticationsPaymentInformationTokenizedCard. :rtype: str @@ -200,7 +200,7 @@ def security_code(self): def security_code(self, security_code): """ Sets the security_code of this Riskv1authenticationsPaymentInformationTokenizedCard. - Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. For details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) + Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. :param security_code: The security_code of this Riskv1authenticationsPaymentInformationTokenizedCard. :type: str diff --git a/CyberSource/models/riskv1authenticationsetups_payment_information_tokenized_card.py b/CyberSource/models/riskv1authenticationsetups_payment_information_tokenized_card.py index 34eb0288..b436d4ef 100644 --- a/CyberSource/models/riskv1authenticationsetups_payment_information_tokenized_card.py +++ b/CyberSource/models/riskv1authenticationsetups_payment_information_tokenized_card.py @@ -112,7 +112,7 @@ def type(self, type): def expiration_month(self): """ Gets the expiration_month of this Riskv1authenticationsetupsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :return: The expiration_month of this Riskv1authenticationsetupsPaymentInformationTokenizedCard. :rtype: str @@ -123,7 +123,7 @@ def expiration_month(self): def expiration_month(self, expiration_month): """ Sets the expiration_month of this Riskv1authenticationsetupsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :param expiration_month: The expiration_month of this Riskv1authenticationsetupsPaymentInformationTokenizedCard. :type: str @@ -135,7 +135,7 @@ def expiration_month(self, expiration_month): def expiration_year(self): """ Gets the expiration_year of this Riskv1authenticationsetupsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :return: The expiration_year of this Riskv1authenticationsetupsPaymentInformationTokenizedCard. :rtype: str @@ -146,7 +146,7 @@ def expiration_year(self): def expiration_year(self, expiration_year): """ Sets the expiration_year of this Riskv1authenticationsetupsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :param expiration_year: The expiration_year of this Riskv1authenticationsetupsPaymentInformationTokenizedCard. :type: str diff --git a/CyberSource/models/riskv1authenticationsetups_processing_information.py b/CyberSource/models/riskv1authenticationsetups_processing_information.py index 7bc4883f..15a9559f 100644 --- a/CyberSource/models/riskv1authenticationsetups_processing_information.py +++ b/CyberSource/models/riskv1authenticationsetups_processing_information.py @@ -56,7 +56,7 @@ def __init__(self, payment_solution=None, visa_checkout_id=None): def payment_solution(self): """ Gets the payment_solution of this Riskv1authenticationsetupsProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :return: The payment_solution of this Riskv1authenticationsetupsProcessingInformation. :rtype: str @@ -67,7 +67,7 @@ def payment_solution(self): def payment_solution(self, payment_solution): """ Sets the payment_solution of this Riskv1authenticationsetupsProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :param payment_solution: The payment_solution of this Riskv1authenticationsetupsProcessingInformation. :type: str diff --git a/CyberSource/models/riskv1decisions_order_information_amount_details.py b/CyberSource/models/riskv1decisions_order_information_amount_details.py index aed4af00..caf1783c 100644 --- a/CyberSource/models/riskv1decisions_order_information_amount_details.py +++ b/CyberSource/models/riskv1decisions_order_information_amount_details.py @@ -78,7 +78,7 @@ def currency(self, currency): def total_amount(self): """ Gets the total_amount of this Riskv1decisionsOrderInformationAmountDetails. - Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. 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. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [REST API Fields Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html) #### DCC for First Data Not used. For details, see [REST API Field Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html) :return: The total_amount of this Riskv1decisionsOrderInformationAmountDetails. :rtype: str @@ -89,7 +89,7 @@ def total_amount(self): def total_amount(self, total_amount): """ Sets the total_amount of this Riskv1decisionsOrderInformationAmountDetails. - Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. + Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. 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. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [REST API Fields Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html) #### DCC for First Data Not used. For details, see [REST API Field Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html) :param total_amount: The total_amount of this Riskv1decisionsOrderInformationAmountDetails. :type: str diff --git a/CyberSource/models/riskv1decisions_order_information_line_items.py b/CyberSource/models/riskv1decisions_order_information_line_items.py index cbed8603..c16f6591 100644 --- a/CyberSource/models/riskv1decisions_order_information_line_items.py +++ b/CyberSource/models/riskv1decisions_order_information_line_items.py @@ -149,7 +149,7 @@ def total_amount(self, total_amount): def unit_price(self): """ Gets the unit_price of this Riskv1decisionsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Riskv1decisionsOrderInformationLineItems. :rtype: str @@ -160,7 +160,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Riskv1decisionsOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Riskv1decisionsOrderInformationLineItems. :type: str @@ -195,7 +195,7 @@ def quantity(self, quantity): def gift_card_currency(self): """ Gets the gift_card_currency of this Riskv1decisionsOrderInformationLineItems. - When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) + When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) :return: The gift_card_currency of this Riskv1decisionsOrderInformationLineItems. :rtype: int @@ -206,7 +206,7 @@ def gift_card_currency(self): def gift_card_currency(self, gift_card_currency): """ Sets the gift_card_currency of this Riskv1decisionsOrderInformationLineItems. - When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) + When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) :param gift_card_currency: The gift_card_currency of this Riskv1decisionsOrderInformationLineItems. :type: int @@ -310,7 +310,7 @@ def product_name(self, product_name): def product_code(self): """ Gets the product_code of this Riskv1decisionsOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :return: The product_code of this Riskv1decisionsOrderInformationLineItems. :rtype: str @@ -321,7 +321,7 @@ def product_code(self): def product_code(self, product_code): """ Sets the product_code of this Riskv1decisionsOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :param product_code: The product_code of this Riskv1decisionsOrderInformationLineItems. :type: str diff --git a/CyberSource/models/riskv1decisions_payment_information_tokenized_card.py b/CyberSource/models/riskv1decisions_payment_information_tokenized_card.py index ecb1522c..c29f186f 100644 --- a/CyberSource/models/riskv1decisions_payment_information_tokenized_card.py +++ b/CyberSource/models/riskv1decisions_payment_information_tokenized_card.py @@ -140,7 +140,7 @@ def number(self, number): def expiration_month(self): """ Gets the expiration_month of this Riskv1decisionsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :return: The expiration_month of this Riskv1decisionsPaymentInformationTokenizedCard. :rtype: str @@ -151,7 +151,7 @@ def expiration_month(self): def expiration_month(self, expiration_month): """ Sets the expiration_month of this Riskv1decisionsPaymentInformationTokenizedCard. - One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. :param expiration_month: The expiration_month of this Riskv1decisionsPaymentInformationTokenizedCard. :type: str @@ -163,7 +163,7 @@ def expiration_month(self, expiration_month): def expiration_year(self): """ Gets the expiration_year of this Riskv1decisionsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :return: The expiration_year of this Riskv1decisionsPaymentInformationTokenizedCard. :rtype: str @@ -174,7 +174,7 @@ def expiration_year(self): def expiration_year(self, expiration_year): """ Sets the expiration_year of this Riskv1decisionsPaymentInformationTokenizedCard. - One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. :param expiration_year: The expiration_year of this Riskv1decisionsPaymentInformationTokenizedCard. :type: str diff --git a/CyberSource/models/riskv1exportcomplianceinquiries_order_information_line_items.py b/CyberSource/models/riskv1exportcomplianceinquiries_order_information_line_items.py index c409c473..16acc189 100644 --- a/CyberSource/models/riskv1exportcomplianceinquiries_order_information_line_items.py +++ b/CyberSource/models/riskv1exportcomplianceinquiries_order_information_line_items.py @@ -85,7 +85,7 @@ def __init__(self, unit_price=None, allowed_export_countries=None, restricted_ex def unit_price(self): """ Gets the unit_price of this Riskv1exportcomplianceinquiriesOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Riskv1exportcomplianceinquiriesOrderInformationLineItems. :rtype: str @@ -96,7 +96,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Riskv1exportcomplianceinquiriesOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Riskv1exportcomplianceinquiriesOrderInformationLineItems. :type: str @@ -242,7 +242,7 @@ def product_name(self, product_name): def product_code(self): """ Gets the product_code of this Riskv1exportcomplianceinquiriesOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :return: The product_code of this Riskv1exportcomplianceinquiriesOrderInformationLineItems. :rtype: str @@ -253,7 +253,7 @@ def product_code(self): def product_code(self, product_code): """ Sets the product_code of this Riskv1exportcomplianceinquiriesOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :param product_code: The product_code of this Riskv1exportcomplianceinquiriesOrderInformationLineItems. :type: str diff --git a/CyberSource/models/riskv1liststypeentries_order_information_line_items.py b/CyberSource/models/riskv1liststypeentries_order_information_line_items.py index dbb9a887..5467daed 100644 --- a/CyberSource/models/riskv1liststypeentries_order_information_line_items.py +++ b/CyberSource/models/riskv1liststypeentries_order_information_line_items.py @@ -51,7 +51,7 @@ def __init__(self, unit_price=None): def unit_price(self): """ Gets the unit_price of this Riskv1liststypeentriesOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Riskv1liststypeentriesOrderInformationLineItems. :rtype: str @@ -62,7 +62,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Riskv1liststypeentriesOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Riskv1liststypeentriesOrderInformationLineItems. :type: str diff --git a/CyberSource/models/tms_embedded_instrument_identifier_bank_account.py b/CyberSource/models/tms_embedded_instrument_identifier_bank_account.py index 46abd79e..bd6ae303 100644 --- a/CyberSource/models/tms_embedded_instrument_identifier_bank_account.py +++ b/CyberSource/models/tms_embedded_instrument_identifier_bank_account.py @@ -79,7 +79,7 @@ def number(self, number): def routing_number(self): """ Gets the routing_number of this TmsEmbeddedInstrumentIdentifierBankAccount. - Bank routing number. This is also called the transit number. For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + Bank routing number. This is also called the transit number. :return: The routing_number of this TmsEmbeddedInstrumentIdentifierBankAccount. :rtype: str @@ -90,7 +90,7 @@ def routing_number(self): def routing_number(self, routing_number): """ Sets the routing_number of this TmsEmbeddedInstrumentIdentifierBankAccount. - Bank routing number. This is also called the transit number. For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + Bank routing number. This is also called the transit number. :param routing_number: The routing_number of this TmsEmbeddedInstrumentIdentifierBankAccount. :type: str diff --git a/CyberSource/models/tms_payment_instrument_processing_info.py b/CyberSource/models/tms_payment_instrument_processing_info.py index 6e1f7219..9f0b065b 100644 --- a/CyberSource/models/tms_payment_instrument_processing_info.py +++ b/CyberSource/models/tms_payment_instrument_processing_info.py @@ -56,7 +56,7 @@ def __init__(self, bill_payment_program_enabled=None, bank_transfer_options=None def bill_payment_program_enabled(self): """ Gets the bill_payment_program_enabled of this TmsPaymentInstrumentProcessingInfo. - Flag that indicates that this is a payment for a bill or for an existing contractual loan. For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) Possible Values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. + Flag that indicates that this is a payment for a bill or for an existing contractual loan. Possible Values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. :return: The bill_payment_program_enabled of this TmsPaymentInstrumentProcessingInfo. :rtype: bool @@ -67,7 +67,7 @@ def bill_payment_program_enabled(self): def bill_payment_program_enabled(self, bill_payment_program_enabled): """ Sets the bill_payment_program_enabled of this TmsPaymentInstrumentProcessingInfo. - Flag that indicates that this is a payment for a bill or for an existing contractual loan. For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) Possible Values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. + Flag that indicates that this is a payment for a bill or for an existing contractual loan. Possible Values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. :param bill_payment_program_enabled: The bill_payment_program_enabled of this TmsPaymentInstrumentProcessingInfo. :type: bool diff --git a/CyberSource/models/tms_payment_instrument_processing_info_bank_transfer_options.py b/CyberSource/models/tms_payment_instrument_processing_info_bank_transfer_options.py index b78524a6..e610f91d 100644 --- a/CyberSource/models/tms_payment_instrument_processing_info_bank_transfer_options.py +++ b/CyberSource/models/tms_payment_instrument_processing_info_bank_transfer_options.py @@ -51,7 +51,7 @@ def __init__(self, sec_code=None): def sec_code(self): """ Gets the sec_code of this TmsPaymentInstrumentProcessingInfoBankTransferOptions. - Specifies the authorization method for the transaction. #### TeleCheck Possible Values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + Specifies the authorization method for the transaction. #### TeleCheck Possible Values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry :return: The sec_code of this TmsPaymentInstrumentProcessingInfoBankTransferOptions. :rtype: str @@ -62,7 +62,7 @@ def sec_code(self): def sec_code(self, sec_code): """ Sets the sec_code of this TmsPaymentInstrumentProcessingInfoBankTransferOptions. - Specifies the authorization method for the transaction. #### TeleCheck Possible Values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) + Specifies the authorization method for the transaction. #### TeleCheck Possible Values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry :param sec_code: The sec_code of this TmsPaymentInstrumentProcessingInfoBankTransferOptions. :type: str diff --git a/CyberSource/models/tmsv2customers_embedded_default_payment_instrument_buyer_information.py b/CyberSource/models/tmsv2customers_embedded_default_payment_instrument_buyer_information.py index 6d299d2f..d4f5b73c 100644 --- a/CyberSource/models/tmsv2customers_embedded_default_payment_instrument_buyer_information.py +++ b/CyberSource/models/tmsv2customers_embedded_default_payment_instrument_buyer_information.py @@ -89,7 +89,7 @@ def company_tax_id(self, company_tax_id): def currency(self): """ Gets the currency of this Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation. - Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) 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. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). + Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) 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. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). :return: The currency of this Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation. :rtype: str @@ -100,7 +100,7 @@ def currency(self): def currency(self, currency): """ Sets the currency of this Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation. - Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) 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. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). + Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) 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. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). :param currency: The currency of this Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation. :type: str diff --git a/CyberSource/models/tss_v2_transactions_get200_response_order_information_line_items.py b/CyberSource/models/tss_v2_transactions_get200_response_order_information_line_items.py index 77b491c8..217af525 100644 --- a/CyberSource/models/tss_v2_transactions_get200_response_order_information_line_items.py +++ b/CyberSource/models/tss_v2_transactions_get200_response_order_information_line_items.py @@ -150,7 +150,7 @@ def product_sku(self, product_sku): def tax_amount(self): """ Gets the tax_amount of this TssV2TransactionsGet200ResponseOrderInformationLineItems. - Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. - 1st line item has `amount=10.00`, `quantity=1`, and `taxAmount=0.80` - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60` 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. For details, see `tax_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. - 1st line item has `amount=10.00`, `quantity=1`, and `taxAmount=0.80` - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60` 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. :return: The tax_amount of this TssV2TransactionsGet200ResponseOrderInformationLineItems. :rtype: str @@ -161,7 +161,7 @@ def tax_amount(self): def tax_amount(self, tax_amount): """ Sets the tax_amount of this TssV2TransactionsGet200ResponseOrderInformationLineItems. - Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. - 1st line item has `amount=10.00`, `quantity=1`, and `taxAmount=0.80` - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60` 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. For details, see `tax_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) + Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. - 1st line item has `amount=10.00`, `quantity=1`, and `taxAmount=0.80` - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60` 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. :param tax_amount: The tax_amount of this TssV2TransactionsGet200ResponseOrderInformationLineItems. :type: str @@ -196,7 +196,7 @@ def quantity(self, quantity): def unit_price(self): """ Gets the unit_price of this TssV2TransactionsGet200ResponseOrderInformationLineItems. - Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. :return: The unit_price of this TssV2TransactionsGet200ResponseOrderInformationLineItems. :rtype: str @@ -207,7 +207,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this TssV2TransactionsGet200ResponseOrderInformationLineItems. - Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. :param unit_price: The unit_price of this TssV2TransactionsGet200ResponseOrderInformationLineItems. :type: str diff --git a/CyberSource/models/tss_v2_transactions_get200_response_order_information_ship_to.py b/CyberSource/models/tss_v2_transactions_get200_response_order_information_ship_to.py index 4661fbb7..95b038b0 100644 --- a/CyberSource/models/tss_v2_transactions_get200_response_order_information_ship_to.py +++ b/CyberSource/models/tss_v2_transactions_get200_response_order_information_ship_to.py @@ -257,7 +257,7 @@ def postal_code(self, postal_code): def company(self): """ Gets the company of this TssV2TransactionsGet200ResponseOrderInformationShipTo. - Name of the customer's company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Name of the customer's company. :return: The company of this TssV2TransactionsGet200ResponseOrderInformationShipTo. :rtype: str @@ -268,7 +268,7 @@ def company(self): def company(self, company): """ Sets the company of this TssV2TransactionsGet200ResponseOrderInformationShipTo. - Name of the customer's company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + Name of the customer's company. :param company: The company of this TssV2TransactionsGet200ResponseOrderInformationShipTo. :type: str diff --git a/CyberSource/models/tss_v2_transactions_get200_response_processing_information_authorization_options_initiator.py b/CyberSource/models/tss_v2_transactions_get200_response_processing_information_authorization_options_initiator.py index a6b63dc8..66bd5b90 100644 --- a/CyberSource/models/tss_v2_transactions_get200_response_processing_information_authorization_options_initiator.py +++ b/CyberSource/models/tss_v2_transactions_get200_response_processing_information_authorization_options_initiator.py @@ -89,7 +89,7 @@ def type(self, type): def credential_stored_on_file(self): """ Gets the credential_stored_on_file of this TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator. - Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `N` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. + Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `N` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. :return: The credential_stored_on_file of this TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator. :rtype: str @@ -100,7 +100,7 @@ def credential_stored_on_file(self): def credential_stored_on_file(self, credential_stored_on_file): """ Sets the credential_stored_on_file of this TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator. - Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `N` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. + Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `N` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. :param credential_stored_on_file: The credential_stored_on_file of this TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator. :type: str diff --git a/CyberSource/models/tss_v2_transactions_get200_response_processor_information.py b/CyberSource/models/tss_v2_transactions_get200_response_processor_information.py index 4b59881c..a9f76f0c 100644 --- a/CyberSource/models/tss_v2_transactions_get200_response_processor_information.py +++ b/CyberSource/models/tss_v2_transactions_get200_response_processor_information.py @@ -165,7 +165,7 @@ def multi_processor_routing(self, multi_processor_routing): def transaction_id(self): """ Gets the transaction_id of this TssV2TransactionsGet200ResponseProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :return: The transaction_id of this TssV2TransactionsGet200ResponseProcessorInformation. :rtype: str @@ -176,7 +176,7 @@ def transaction_id(self): def transaction_id(self, transaction_id): """ Sets the transaction_id of this TssV2TransactionsGet200ResponseProcessorInformation. - Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 + Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 :param transaction_id: The transaction_id of this TssV2TransactionsGet200ResponseProcessorInformation. :type: str diff --git a/CyberSource/models/tss_v2_transactions_post201_response_embedded_processing_information.py b/CyberSource/models/tss_v2_transactions_post201_response_embedded_processing_information.py index 5f1496cc..190c8744 100644 --- a/CyberSource/models/tss_v2_transactions_post201_response_embedded_processing_information.py +++ b/CyberSource/models/tss_v2_transactions_post201_response_embedded_processing_information.py @@ -66,7 +66,7 @@ def __init__(self, payment_solution=None, business_application_id=None, commerce def payment_solution(self): """ Gets the payment_solution of this TssV2TransactionsPost201ResponseEmbeddedProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :return: The payment_solution of this TssV2TransactionsPost201ResponseEmbeddedProcessingInformation. :rtype: str @@ -77,7 +77,7 @@ def payment_solution(self): def payment_solution(self, payment_solution): """ Sets the payment_solution of this TssV2TransactionsPost201ResponseEmbeddedProcessingInformation. - Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. + Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. :param payment_solution: The payment_solution of this TssV2TransactionsPost201ResponseEmbeddedProcessingInformation. :type: str diff --git a/CyberSource/models/tss_v2_transactions_post201_response_embedded_risk_information_providers_fingerprint.py b/CyberSource/models/tss_v2_transactions_post201_response_embedded_risk_information_providers_fingerprint.py index 259b5046..42d23dac 100644 --- a/CyberSource/models/tss_v2_transactions_post201_response_embedded_risk_information_providers_fingerprint.py +++ b/CyberSource/models/tss_v2_transactions_post201_response_embedded_risk_information_providers_fingerprint.py @@ -84,7 +84,7 @@ def true_ipaddress(self, true_ipaddress): def hash(self): """ Gets the hash of this TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint. - The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field. NOTE: For details about the value of this field, see the `decision_provider_#_field_#_value` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). For more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). + The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field. For more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). :return: The hash of this TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint. :rtype: str @@ -95,7 +95,7 @@ def hash(self): def hash(self, hash): """ Sets the hash of this TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint. - The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field. NOTE: For details about the value of this field, see the `decision_provider_#_field_#_value` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). For more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). + The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field. For more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). :param hash: The hash of this TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint. :type: str diff --git a/CyberSource/models/vasv2tax_merchant_information.py b/CyberSource/models/vasv2tax_merchant_information.py index 09cd6eaf..fd532041 100644 --- a/CyberSource/models/vasv2tax_merchant_information.py +++ b/CyberSource/models/vasv2tax_merchant_information.py @@ -51,7 +51,7 @@ def __init__(self, vat_registration_number=None): def vat_registration_number(self): """ Gets the vat_registration_number of this Vasv2taxMerchantInformation. - Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description 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) + Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. :return: The vat_registration_number of this Vasv2taxMerchantInformation. :rtype: str @@ -62,7 +62,7 @@ def vat_registration_number(self): def vat_registration_number(self, vat_registration_number): """ Sets the vat_registration_number of this Vasv2taxMerchantInformation. - Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description 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) + Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. :param vat_registration_number: The vat_registration_number of this Vasv2taxMerchantInformation. :type: str diff --git a/CyberSource/models/vasv2tax_order_information_line_items.py b/CyberSource/models/vasv2tax_order_information_line_items.py index 17f7a0ec..92817233 100644 --- a/CyberSource/models/vasv2tax_order_information_line_items.py +++ b/CyberSource/models/vasv2tax_order_information_line_items.py @@ -139,7 +139,7 @@ def product_sku(self, product_sku): def product_code(self): """ Gets the product_code of this Vasv2taxOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :return: The product_code of this Vasv2taxOrderInformationLineItems. :rtype: str @@ -150,7 +150,7 @@ def product_code(self): def product_code(self, product_code): """ Sets the product_code of this Vasv2taxOrderInformationLineItems. - Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. + Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. :param product_code: The product_code of this Vasv2taxOrderInformationLineItems. :type: str @@ -208,7 +208,7 @@ def product_name(self, product_name): def unit_price(self): """ Gets the unit_price of this Vasv2taxOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :return: The unit_price of this Vasv2taxOrderInformationLineItems. :rtype: str @@ -219,7 +219,7 @@ def unit_price(self): def unit_price(self, unit_price): """ Sets the unit_price of this Vasv2taxOrderInformationLineItems. - Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) + Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) :param unit_price: The unit_price of this Vasv2taxOrderInformationLineItems. :type: str @@ -411,7 +411,7 @@ def buyer_vat_registration_number(self, buyer_vat_registration_number): def seller_vat_registration_number(self): """ Gets the seller_vat_registration_number of this Vasv2taxOrderInformationLineItems. - VAT seller registration number. For details, see \"International Taxes and Value-Added Tax (VAT)\" in [Tax Calculation Service Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Tax_SCMP_API/html/). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes. + VAT seller registration number. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes. :return: The seller_vat_registration_number of this Vasv2taxOrderInformationLineItems. :rtype: str @@ -422,7 +422,7 @@ def seller_vat_registration_number(self): def seller_vat_registration_number(self, seller_vat_registration_number): """ Sets the seller_vat_registration_number of this Vasv2taxOrderInformationLineItems. - VAT seller registration number. For details, see \"International Taxes and Value-Added Tax (VAT)\" in [Tax Calculation Service Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Tax_SCMP_API/html/). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes. + VAT seller registration number. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes. :param seller_vat_registration_number: The seller_vat_registration_number of this Vasv2taxOrderInformationLineItems. :type: str diff --git a/docs/BinLookupApi.md b/docs/BinLookupApi.md new file mode 100644 index 00000000..88358466 --- /dev/null +++ b/docs/BinLookupApi.md @@ -0,0 +1,57 @@ +# CyberSource.BinLookupApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_account_info**](BinLookupApi.md#get_account_info) | **POST** /bin/v1/binlookup | BIN Lookup API + + +# **get_account_info** +> InlineResponse2011 get_account_info(create_bin_lookup_request) + +BIN Lookup API + +The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources. This service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses with a flexible choice of inputs such as primary account number (PAN), network token from major networks which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS). Currently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant. + +### Example +```python +from __future__ import print_function +import time +import CyberSource +from CyberSource.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = CyberSource.BinLookupApi() +create_bin_lookup_request = CyberSource.CreateBinLookupRequest() # CreateBinLookupRequest | + +try: + # BIN Lookup API + api_response = api_instance.get_account_info(create_bin_lookup_request) + pprint(api_response) +except ApiException as e: + print("Exception when calling BinLookupApi->get_account_info: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **create_bin_lookup_request** | [**CreateBinLookupRequest**](CreateBinLookupRequest.md)| | + +### Return type + +[**InlineResponse2011**](InlineResponse2011.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TssV2TransactionsPost400Response.md b/docs/BinLookupv400Response.md similarity index 96% rename from docs/TssV2TransactionsPost400Response.md rename to docs/BinLookupv400Response.md index fa70bac8..53b77998 100644 --- a/docs/TssV2TransactionsPost400Response.md +++ b/docs/BinLookupv400Response.md @@ -1,4 +1,4 @@ -# TssV2TransactionsPost400Response +# BinLookupv400Response ## Properties Name | Type | Description | Notes diff --git a/docs/Binv1binlookupClientReferenceInformation.md b/docs/Binv1binlookupClientReferenceInformation.md new file mode 100644 index 00000000..a5b077c8 --- /dev/null +++ b/docs/Binv1binlookupClientReferenceInformation.md @@ -0,0 +1,13 @@ +# Binv1binlookupClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**partner** | [**Riskv1decisionsClientReferenceInformationPartner**](Riskv1decisionsClientReferenceInformationPartner.md) | | [optional] +**application_name** | **str** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional] +**application_version** | **str** | Version of the CyberSource application or integration used for a transaction. | [optional] +**application_user** | **str** | The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Binv1binlookupPaymentInformation.md b/docs/Binv1binlookupPaymentInformation.md new file mode 100644 index 00000000..1764b45c --- /dev/null +++ b/docs/Binv1binlookupPaymentInformation.md @@ -0,0 +1,13 @@ +# Binv1binlookupPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**Binv1binlookupPaymentInformationCard**](Binv1binlookupPaymentInformationCard.md) | | [optional] +**customer** | [**GetAllSubscriptionsResponsePaymentInformationCustomer**](GetAllSubscriptionsResponsePaymentInformationCustomer.md) | | [optional] +**payment_instrument** | [**Ptsv2paymentsPaymentInformationPaymentInstrument**](Ptsv2paymentsPaymentInformationPaymentInstrument.md) | | [optional] +**instrument_identifier** | [**Ptsv2paymentsPaymentInformationInstrumentIdentifier**](Ptsv2paymentsPaymentInformationInstrumentIdentifier.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Binv1binlookupPaymentInformationCard.md b/docs/Binv1binlookupPaymentInformationCard.md new file mode 100644 index 00000000..db9f10ee --- /dev/null +++ b/docs/Binv1binlookupPaymentInformationCard.md @@ -0,0 +1,10 @@ +# Binv1binlookupPaymentInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **str** | The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Binv1binlookupProcessingInformation.md b/docs/Binv1binlookupProcessingInformation.md new file mode 100644 index 00000000..09b5b1eb --- /dev/null +++ b/docs/Binv1binlookupProcessingInformation.md @@ -0,0 +1,11 @@ +# Binv1binlookupProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bin_source** | **str** | Bin Source File Identifier. Possible values: - itmx - rupay | [optional] +**payout_options** | [**Binv1binlookupProcessingInformationPayoutOptions**](Binv1binlookupProcessingInformationPayoutOptions.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Binv1binlookupProcessingInformationPayoutOptions.md b/docs/Binv1binlookupProcessingInformationPayoutOptions.md new file mode 100644 index 00000000..496b53ec --- /dev/null +++ b/docs/Binv1binlookupProcessingInformationPayoutOptions.md @@ -0,0 +1,12 @@ +# Binv1binlookupProcessingInformationPayoutOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payout_inquiry** | **bool** | If `true` then provide attributes related to fund transfer/payouts. If payout information not found then response will have standard account lookup. Possible values: - true - false | [optional] +**network_id** | **str** | The networks specified in this field must be a subset of the information provided during program enrollment Possible values: - 0020 : Accel/Exchange - 0024 : CU24 - 0003 : Interlink - 0016 : Maestro - 0018 : NYCE - 0027 : NYCE - 0009 : Pulse - 0017 : Pulse - 0019 : Pulse - 0008 : Star - 0010 : Star - 0011 : Star - 0012 : Star - 0015 : Star - 0002 : Visa/PLUS | [optional] +**acquirer_bin** | **str** | BIN under which the Funds Transfer application is registered. This must match the information provided during enrollment. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Binv1binlookupTokenInformation.md b/docs/Binv1binlookupTokenInformation.md new file mode 100644 index 00000000..2a5d0026 --- /dev/null +++ b/docs/Binv1binlookupTokenInformation.md @@ -0,0 +1,11 @@ +# Binv1binlookupTokenInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**jti** | **str** | TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV). | [optional] +**transient_token_jwt** | **str** | Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateBinLookupRequest.md b/docs/CreateBinLookupRequest.md new file mode 100644 index 00000000..28b28cdf --- /dev/null +++ b/docs/CreateBinLookupRequest.md @@ -0,0 +1,13 @@ +# CreateBinLookupRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**client_reference_information** | [**Binv1binlookupClientReferenceInformation**](Binv1binlookupClientReferenceInformation.md) | | [optional] +**payment_information** | [**Binv1binlookupPaymentInformation**](Binv1binlookupPaymentInformation.md) | | [optional] +**token_information** | [**Binv1binlookupTokenInformation**](Binv1binlookupTokenInformation.md) | | [optional] +**processing_information** | [**Binv1binlookupProcessingInformation**](Binv1binlookupProcessingInformation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreateNewWebhooksApi.md b/docs/CreateNewWebhooksApi.md index 925299ca..71e98a92 100644 --- a/docs/CreateNewWebhooksApi.md +++ b/docs/CreateNewWebhooksApi.md @@ -10,7 +10,7 @@ Method | HTTP request | Description # **create_webhook_subscription** -> InlineResponse2013 create_webhook_subscription(create_webhook_request=create_webhook_request) +> InlineResponse2014 create_webhook_subscription(create_webhook_request=create_webhook_request) Create a Webhook @@ -44,7 +44,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2013**](InlineResponse2013.md) +[**InlineResponse2014**](InlineResponse2014.md) ### Authorization @@ -106,7 +106,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **save_sym_egress_key** -> InlineResponse2012 save_sym_egress_key(v_c_sender_organization_id, v_c_permissions, v_c_correlation_id=v_c_correlation_id, save_sym_egress_key=save_sym_egress_key) +> InlineResponse2013 save_sym_egress_key(v_c_sender_organization_id, v_c_permissions, v_c_correlation_id=v_c_correlation_id, save_sym_egress_key=save_sym_egress_key) Create Webhook Security Keys @@ -146,7 +146,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2012**](InlineResponse2012.md) +[**InlineResponse2013**](InlineResponse2013.md) ### Authorization diff --git a/docs/InlineResponse2002.md b/docs/InlineResponse2002.md index 4cbcbc6f..f83d8ee9 100644 --- a/docs/InlineResponse2002.md +++ b/docs/InlineResponse2002.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **integration_information** | [**InlineResponse2002IntegrationInformation**](InlineResponse2002IntegrationInformation.md) | | [optional] **organization_information** | [**Boardingv1registrationsOrganizationInformation**](Boardingv1registrationsOrganizationInformation.md) | | [optional] **product_information** | [**Boardingv1registrationsProductInformation**](Boardingv1registrationsProductInformation.md) | | [optional] -**product_information_setups** | [**list[InlineResponse2011ProductInformationSetups]**](InlineResponse2011ProductInformationSetups.md) | | [optional] +**product_information_setups** | [**list[InlineResponse2012ProductInformationSetups]**](InlineResponse2012ProductInformationSetups.md) | | [optional] **document_information** | [**Boardingv1registrationsDocumentInformation**](Boardingv1registrationsDocumentInformation.md) | | [optional] **details** | **dict(str, list[object])** | | [optional] diff --git a/docs/InlineResponse2011.md b/docs/InlineResponse2011.md index 718d3067..a7d07aa7 100644 --- a/docs/InlineResponse2011.md +++ b/docs/InlineResponse2011.md @@ -3,15 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | [optional] -**submit_time_utc** | **date** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | **str** | The status of Registration request Possible Values: - 'INITIALIZED' - 'RECEIVED' - 'PROCESSING' - 'SUCCESS' - 'FAILURE' - 'PARTIAL' | [optional] -**registration_information** | [**InlineResponse2011RegistrationInformation**](InlineResponse2011RegistrationInformation.md) | | [optional] -**integration_information** | [**InlineResponse2011IntegrationInformation**](InlineResponse2011IntegrationInformation.md) | | [optional] -**organization_information** | [**InlineResponse2011OrganizationInformation**](InlineResponse2011OrganizationInformation.md) | | [optional] -**product_information_setups** | [**list[InlineResponse2011ProductInformationSetups]**](InlineResponse2011ProductInformationSetups.md) | | [optional] -**message** | **str** | | [optional] -**details** | **dict(str, list[object])** | | [optional] +**id** | **str** | 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] +**submit_time_utc** | **str** | 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] +**status** | **str** | The status of the submitted transaction. Possible values: - COMPLETED - MULTIPLE - NO MATCH | [optional] +**payment_account_information** | [**InlineResponse2011PaymentAccountInformation**](InlineResponse2011PaymentAccountInformation.md) | | [optional] +**issuer_information** | [**InlineResponse2011IssuerInformation**](InlineResponse2011IssuerInformation.md) | | [optional] +**payout_information** | [**InlineResponse2011PayoutInformation**](InlineResponse2011PayoutInformation.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2011IssuerInformation.md b/docs/InlineResponse2011IssuerInformation.md new file mode 100644 index 00000000..96745776 --- /dev/null +++ b/docs/InlineResponse2011IssuerInformation.md @@ -0,0 +1,14 @@ +# InlineResponse2011IssuerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **str** | This field contains the issuer name. | [optional] +**country** | **str** | This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer. | [optional] +**bin_length** | **str** | This field contains the length of the BIN. | [optional] +**account_prefix** | **str** | This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers). | [optional] +**phone_number** | **str** | This field contains the customer service phone number for the issuer. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2011PaymentAccountInformation.md b/docs/InlineResponse2011PaymentAccountInformation.md new file mode 100644 index 00000000..b74dd7aa --- /dev/null +++ b/docs/InlineResponse2011PaymentAccountInformation.md @@ -0,0 +1,12 @@ +# InlineResponse2011PaymentAccountInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**InlineResponse2011PaymentAccountInformationCard**](InlineResponse2011PaymentAccountInformationCard.md) | | [optional] +**features** | [**InlineResponse2011PaymentAccountInformationFeatures**](InlineResponse2011PaymentAccountInformationFeatures.md) | | [optional] +**network** | [**InlineResponse2011PaymentAccountInformationNetwork**](InlineResponse2011PaymentAccountInformationNetwork.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2011PaymentAccountInformationCard.md b/docs/InlineResponse2011PaymentAccountInformationCard.md new file mode 100644 index 00000000..b5929f9e --- /dev/null +++ b/docs/InlineResponse2011PaymentAccountInformationCard.md @@ -0,0 +1,15 @@ +# InlineResponse2011PaymentAccountInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | This field contains the 3-digit value that indicates the card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: Enroute[^1] - `015`: Lowes Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Switch/Solo - `025`: Sams Club Consumer - `026`: Sams Club Business - `027`: Nicos - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `032`: Solo - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style - `046`: J.Crew - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo[^3] - `055`: Capital One Private Label - `058`: Carnet - `059`: ValueLink - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. | [optional] +**brand_name** | **str** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS | [optional] +**currency** | **str** | This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. | [optional] +**max_length** | **str** | This field contains the max length of the card. | [optional] +**credential_type** | **str** | This field contains the type of the payment credential. Possible values: - PAN - TOKEN | [optional] +**brands** | [**list[InlineResponse2011PaymentAccountInformationCardBrands]**](InlineResponse2011PaymentAccountInformationCardBrands.md) | Array of brands | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2011PaymentAccountInformationCardBrands.md b/docs/InlineResponse2011PaymentAccountInformationCardBrands.md new file mode 100644 index 00000000..93950d0d --- /dev/null +++ b/docs/InlineResponse2011PaymentAccountInformationCardBrands.md @@ -0,0 +1,11 @@ +# InlineResponse2011PaymentAccountInformationCardBrands + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | This field contains the 3-digit value that indicates the card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: Walmart - `014`: Enroute[^1] - `015`: Lowes Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportwear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Switch/Solo - `025`: Sams Club Consumer - `026`: Sams Club Business - `027`: Nicos - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `032`: Solo - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style - `046`: J.Crew - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico Card - `054`: Elo[^3] - `055`: Capital One Private Label - `058`: Carnet - `059`: ValueLink - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. | [optional] +**brand_name** | **str** | This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2011PaymentAccountInformationFeatures.md b/docs/InlineResponse2011PaymentAccountInformationFeatures.md new file mode 100644 index 00000000..a2a89afa --- /dev/null +++ b/docs/InlineResponse2011PaymentAccountInformationFeatures.md @@ -0,0 +1,18 @@ +# InlineResponse2011PaymentAccountInformationFeatures + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**account_funding_source** | **str** | This field contains the account funding source. Possible values: - `CREDIT` - `DEBIT` - `PREPAID` - `DEFERRED DEBIT` - `CHARGE` | [optional] +**account_funding_source_sub_type** | **str** | This field contains the type of prepaid card. Possible values: - `Reloadable` - `Non-reloadable` | [optional] +**card_product** | **str** | This field contains the type of issuer product. Example values: - Visa Classic - Visa Signature - Visa Infinite | [optional] +**message_type** | **str** | This field contains the type of BIN based authentication. Possible values: - `S`: Single Message - `D`: Dual Message | [optional] +**acceptance_level** | **str** | This field contains the acceptance level of the PAN. Possible values: - `0` : Normal - `1` : Monitor - `2` : Refuse - `3` : Not Allowed - `4` : Private - `5` : Test | [optional] +**card_platform** | **str** | This field contains the type of card platform. Possible values: - `BUSINESS` - `CONSUMER` - `COMMERCIAL` - `GOVERNMENT` | [optional] +**combo_card** | **str** | This field indicates the type of combo card. Possible values: - 0 (Not a combo card) - 1 (Credit and Prepaid Combo card) - 2 (Credit and Debit Combo card) | [optional] +**corporate_purchase** | **bool** | This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards. Possible values: - `true` - `false` | [optional] +**health_card** | **bool** | This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs. Possible values: - `true` - `false` | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2011PaymentAccountInformationNetwork.md b/docs/InlineResponse2011PaymentAccountInformationNetwork.md new file mode 100644 index 00000000..c01a0763 --- /dev/null +++ b/docs/InlineResponse2011PaymentAccountInformationNetwork.md @@ -0,0 +1,10 @@ +# InlineResponse2011PaymentAccountInformationNetwork + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | This field contains a code that identifies the network. [List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code) | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2011PayoutInformation.md b/docs/InlineResponse2011PayoutInformation.md new file mode 100644 index 00000000..041841fd --- /dev/null +++ b/docs/InlineResponse2011PayoutInformation.md @@ -0,0 +1,12 @@ +# InlineResponse2011PayoutInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**push_funds** | [**InlineResponse2011PayoutInformationPushFunds**](InlineResponse2011PayoutInformationPushFunds.md) | | [optional] +**pull_funds** | [**InlineResponse2011PayoutInformationPullFunds**](InlineResponse2011PayoutInformationPullFunds.md) | | [optional] +**geo_restriction_indicator** | **str** | This field indicates if the recipient issuer can accept transactions from the originator country. Possible values: - `Y` - `N` | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2011PayoutInformationPullFunds.md b/docs/InlineResponse2011PayoutInformationPullFunds.md new file mode 100644 index 00000000..1bc6ea5f --- /dev/null +++ b/docs/InlineResponse2011PayoutInformationPullFunds.md @@ -0,0 +1,11 @@ +# InlineResponse2011PayoutInformationPullFunds + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**domestic_participant** | **str** | This field indicates if domestic AFTs (pull funds) are allowed. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` | [optional] +**cross_border_participant** | **str** | This field indicates if cross-border AFTs (pull funds) are allowed. Note: Supported only in US for cross-border transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2011PayoutInformationPushFunds.md b/docs/InlineResponse2011PayoutInformationPushFunds.md new file mode 100644 index 00000000..fab78be1 --- /dev/null +++ b/docs/InlineResponse2011PayoutInformationPushFunds.md @@ -0,0 +1,23 @@ +# InlineResponse2011PayoutInformationPushFunds + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**money_transfer_fast_funds_cross_border** | **str** | This field indicates if cross-border money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**money_transfer_fast_funds_domestic** | **str** | This field indicates if domestic money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**money_transfer_cross_border** | **str** | This field indicates if cross-border money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**money_transfer_domestic** | **str** | This field indicates if domestic money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**non_money_transfer_fast_funds_cross_border** | **str** | This field indicates if cross-border non-money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**non_money_transfer_fast_funds_domestic** | **str** | This field indicates if domestic non-money transfer OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**non_money_transfer_cross_border** | **str** | This field indicates if cross-border non-money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**non_money_transfer_domestic** | **str** | This field indicates if domestic non-money transfer OCTs (push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**online_gambling_fast_funds_cross_border** | **str** | This field indicates if cross-border gambling OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**online_gambling_fast_funds_domestic** | **str** | This field indicates if domestic gambling OCTs (fast push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**online_gambling_cross_border** | **str** | This field indicates if cross-border gambling OCTs (push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**online_gambling_domestic** | **str** | This field indicates if domestic gambling OCTs (push funds) are allowed. Possible values: - `Y` - `N` | [optional] +**domestic_participant** | **str** | This field indicates if domestic OCTs (push funds) are allowed. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` | [optional] +**cross_border_participant** | **str** | This field indicates if cross-border OCTs (push funds) are allowed. Note: Supported only in US for cross-border transactions involving Push Payments Gateway Service(PPGS). Possible values: - `true` - `false` | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2011Setups.md b/docs/InlineResponse2011Setups.md deleted file mode 100644 index 2938a827..00000000 --- a/docs/InlineResponse2011Setups.md +++ /dev/null @@ -1,13 +0,0 @@ -# InlineResponse2011Setups - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**payments** | [**InlineResponse2011SetupsPayments**](InlineResponse2011SetupsPayments.md) | | [optional] -**risk** | [**InlineResponse2011SetupsRisk**](InlineResponse2011SetupsRisk.md) | | [optional] -**commerce_solutions** | [**InlineResponse2011SetupsCommerceSolutions**](InlineResponse2011SetupsCommerceSolutions.md) | | [optional] -**value_added_services** | [**InlineResponse2011SetupsValueAddedServices**](InlineResponse2011SetupsValueAddedServices.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InlineResponse2011SetupsCommerceSolutions.md b/docs/InlineResponse2011SetupsCommerceSolutions.md deleted file mode 100644 index 21331e4d..00000000 --- a/docs/InlineResponse2011SetupsCommerceSolutions.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse2011SetupsCommerceSolutions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**token_management** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**account_updater** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**bin_lookup** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InlineResponse2011SetupsPayments.md b/docs/InlineResponse2011SetupsPayments.md deleted file mode 100644 index de11a260..00000000 --- a/docs/InlineResponse2011SetupsPayments.md +++ /dev/null @@ -1,26 +0,0 @@ -# InlineResponse2011SetupsPayments - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card_processing** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**card_present_connect** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**e_check** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**payer_authentication** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**digital_payments** | [**InlineResponse2011SetupsPaymentsDigitalPayments**](InlineResponse2011SetupsPaymentsDigitalPayments.md) | | [optional] -**secure_acceptance** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**virtual_terminal** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**currency_conversion** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**tax** | [**InlineResponse2011SetupsPaymentsDigitalPayments**](InlineResponse2011SetupsPaymentsDigitalPayments.md) | | [optional] -**customer_invoicing** | [**InlineResponse2011SetupsPaymentsDigitalPayments**](InlineResponse2011SetupsPaymentsDigitalPayments.md) | | [optional] -**recurring_billing** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**cybs_ready_terminal** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**payment_orchestration** | [**InlineResponse2011SetupsPaymentsDigitalPayments**](InlineResponse2011SetupsPaymentsDigitalPayments.md) | | [optional] -**payouts** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**pay_by_link** | [**InlineResponse2011SetupsPaymentsDigitalPayments**](InlineResponse2011SetupsPaymentsDigitalPayments.md) | | [optional] -**unified_checkout** | [**InlineResponse2011SetupsPaymentsDigitalPayments**](InlineResponse2011SetupsPaymentsDigitalPayments.md) | | [optional] -**receivables_manager** | [**InlineResponse2011SetupsPaymentsDigitalPayments**](InlineResponse2011SetupsPaymentsDigitalPayments.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InlineResponse2012.md b/docs/InlineResponse2012.md index 51c53a3b..0b214187 100644 --- a/docs/InlineResponse2012.md +++ b/docs/InlineResponse2012.md @@ -3,10 +3,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - ACCEPTED | [optional] -**client_reference_information** | [**Kmsegressv2keyssymClientReferenceInformation**](Kmsegressv2keyssymClientReferenceInformation.md) | | [optional] -**key_information** | [**InlineResponse2012KeyInformation**](InlineResponse2012KeyInformation.md) | | [optional] +**id** | **str** | | [optional] +**submit_time_utc** | **date** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**status** | **str** | The status of Registration request Possible Values: - 'INITIALIZED' - 'RECEIVED' - 'PROCESSING' - 'SUCCESS' - 'FAILURE' - 'PARTIAL' | [optional] +**registration_information** | [**InlineResponse2012RegistrationInformation**](InlineResponse2012RegistrationInformation.md) | | [optional] +**integration_information** | [**InlineResponse2012IntegrationInformation**](InlineResponse2012IntegrationInformation.md) | | [optional] +**organization_information** | [**InlineResponse2012OrganizationInformation**](InlineResponse2012OrganizationInformation.md) | | [optional] +**product_information_setups** | [**list[InlineResponse2012ProductInformationSetups]**](InlineResponse2012ProductInformationSetups.md) | | [optional] +**message** | **str** | | [optional] +**details** | **dict(str, list[object])** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2011IntegrationInformation.md b/docs/InlineResponse2012IntegrationInformation.md similarity index 72% rename from docs/InlineResponse2011IntegrationInformation.md rename to docs/InlineResponse2012IntegrationInformation.md index deb7d169..711d2dec 100644 --- a/docs/InlineResponse2011IntegrationInformation.md +++ b/docs/InlineResponse2012IntegrationInformation.md @@ -1,9 +1,9 @@ -# InlineResponse2011IntegrationInformation +# InlineResponse2012IntegrationInformation ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**tenant_configurations** | [**list[InlineResponse2011IntegrationInformationTenantConfigurations]**](InlineResponse2011IntegrationInformationTenantConfigurations.md) | tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with. | [optional] +**tenant_configurations** | [**list[InlineResponse2012IntegrationInformationTenantConfigurations]**](InlineResponse2012IntegrationInformationTenantConfigurations.md) | tenantConfigurations is an array of objects that includes the tenant information this merchant is associated with. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2011IntegrationInformationTenantConfigurations.md b/docs/InlineResponse2012IntegrationInformationTenantConfigurations.md similarity index 93% rename from docs/InlineResponse2011IntegrationInformationTenantConfigurations.md rename to docs/InlineResponse2012IntegrationInformationTenantConfigurations.md index 38cc4ced..7acbc303 100644 --- a/docs/InlineResponse2011IntegrationInformationTenantConfigurations.md +++ b/docs/InlineResponse2012IntegrationInformationTenantConfigurations.md @@ -1,4 +1,4 @@ -# InlineResponse2011IntegrationInformationTenantConfigurations +# InlineResponse2012IntegrationInformationTenantConfigurations ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2011OrganizationInformation.md b/docs/InlineResponse2012OrganizationInformation.md similarity index 90% rename from docs/InlineResponse2011OrganizationInformation.md rename to docs/InlineResponse2012OrganizationInformation.md index 9ecb4695..f70e90cd 100644 --- a/docs/InlineResponse2011OrganizationInformation.md +++ b/docs/InlineResponse2012OrganizationInformation.md @@ -1,4 +1,4 @@ -# InlineResponse2011OrganizationInformation +# InlineResponse2012OrganizationInformation ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2011ProductInformationSetups.md b/docs/InlineResponse2012ProductInformationSetups.md similarity index 76% rename from docs/InlineResponse2011ProductInformationSetups.md rename to docs/InlineResponse2012ProductInformationSetups.md index 40989570..c992e49a 100644 --- a/docs/InlineResponse2011ProductInformationSetups.md +++ b/docs/InlineResponse2012ProductInformationSetups.md @@ -1,10 +1,10 @@ -# InlineResponse2011ProductInformationSetups +# InlineResponse2012ProductInformationSetups ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **organization_id** | **str** | | [optional] -**setups** | [**InlineResponse2011Setups**](InlineResponse2011Setups.md) | | [optional] +**setups** | [**InlineResponse2012Setups**](InlineResponse2012Setups.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2011RegistrationInformation.md b/docs/InlineResponse2012RegistrationInformation.md similarity index 92% rename from docs/InlineResponse2011RegistrationInformation.md rename to docs/InlineResponse2012RegistrationInformation.md index 035529a2..ce1a5e4e 100644 --- a/docs/InlineResponse2011RegistrationInformation.md +++ b/docs/InlineResponse2012RegistrationInformation.md @@ -1,4 +1,4 @@ -# InlineResponse2011RegistrationInformation +# InlineResponse2012RegistrationInformation ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2012Setups.md b/docs/InlineResponse2012Setups.md new file mode 100644 index 00000000..7e2a5794 --- /dev/null +++ b/docs/InlineResponse2012Setups.md @@ -0,0 +1,13 @@ +# InlineResponse2012Setups + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**payments** | [**InlineResponse2012SetupsPayments**](InlineResponse2012SetupsPayments.md) | | [optional] +**risk** | [**InlineResponse2012SetupsRisk**](InlineResponse2012SetupsRisk.md) | | [optional] +**commerce_solutions** | [**InlineResponse2012SetupsCommerceSolutions**](InlineResponse2012SetupsCommerceSolutions.md) | | [optional] +**value_added_services** | [**InlineResponse2012SetupsValueAddedServices**](InlineResponse2012SetupsValueAddedServices.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2012SetupsCommerceSolutions.md b/docs/InlineResponse2012SetupsCommerceSolutions.md new file mode 100644 index 00000000..48de108a --- /dev/null +++ b/docs/InlineResponse2012SetupsCommerceSolutions.md @@ -0,0 +1,12 @@ +# InlineResponse2012SetupsCommerceSolutions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**token_management** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**account_updater** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**bin_lookup** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2012SetupsPayments.md b/docs/InlineResponse2012SetupsPayments.md new file mode 100644 index 00000000..b974e739 --- /dev/null +++ b/docs/InlineResponse2012SetupsPayments.md @@ -0,0 +1,26 @@ +# InlineResponse2012SetupsPayments + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card_processing** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**card_present_connect** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**e_check** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**payer_authentication** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**digital_payments** | [**InlineResponse2012SetupsPaymentsDigitalPayments**](InlineResponse2012SetupsPaymentsDigitalPayments.md) | | [optional] +**secure_acceptance** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**virtual_terminal** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**currency_conversion** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**tax** | [**InlineResponse2012SetupsPaymentsDigitalPayments**](InlineResponse2012SetupsPaymentsDigitalPayments.md) | | [optional] +**customer_invoicing** | [**InlineResponse2012SetupsPaymentsDigitalPayments**](InlineResponse2012SetupsPaymentsDigitalPayments.md) | | [optional] +**recurring_billing** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**cybs_ready_terminal** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**payment_orchestration** | [**InlineResponse2012SetupsPaymentsDigitalPayments**](InlineResponse2012SetupsPaymentsDigitalPayments.md) | | [optional] +**payouts** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**pay_by_link** | [**InlineResponse2012SetupsPaymentsDigitalPayments**](InlineResponse2012SetupsPaymentsDigitalPayments.md) | | [optional] +**unified_checkout** | [**InlineResponse2012SetupsPaymentsDigitalPayments**](InlineResponse2012SetupsPaymentsDigitalPayments.md) | | [optional] +**receivables_manager** | [**InlineResponse2012SetupsPaymentsDigitalPayments**](InlineResponse2012SetupsPaymentsDigitalPayments.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/InlineResponse2011SetupsPaymentsCardProcessing.md b/docs/InlineResponse2012SetupsPaymentsCardProcessing.md similarity index 55% rename from docs/InlineResponse2011SetupsPaymentsCardProcessing.md rename to docs/InlineResponse2012SetupsPaymentsCardProcessing.md index b6a69b9a..58d63f42 100644 --- a/docs/InlineResponse2011SetupsPaymentsCardProcessing.md +++ b/docs/InlineResponse2012SetupsPaymentsCardProcessing.md @@ -1,10 +1,10 @@ -# InlineResponse2011SetupsPaymentsCardProcessing +# InlineResponse2012SetupsPaymentsCardProcessing ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**subscription_status** | [**InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus**](InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus.md) | | [optional] -**configuration_status** | [**InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus**](InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus.md) | | [optional] +**subscription_status** | [**InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus**](InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus.md) | | [optional] +**configuration_status** | [**InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus**](InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus.md b/docs/InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus.md similarity index 92% rename from docs/InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus.md rename to docs/InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus.md index a864056a..bd9b1c9c 100644 --- a/docs/InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus.md +++ b/docs/InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus.md @@ -1,4 +1,4 @@ -# InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus +# InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus.md b/docs/InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus.md similarity index 91% rename from docs/InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus.md rename to docs/InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus.md index 13feafd5..fb1a544a 100644 --- a/docs/InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus.md +++ b/docs/InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus.md @@ -1,4 +1,4 @@ -# InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus +# InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2011SetupsPaymentsDigitalPayments.md b/docs/InlineResponse2012SetupsPaymentsDigitalPayments.md similarity index 64% rename from docs/InlineResponse2011SetupsPaymentsDigitalPayments.md rename to docs/InlineResponse2012SetupsPaymentsDigitalPayments.md index c83a58ce..97d8813b 100644 --- a/docs/InlineResponse2011SetupsPaymentsDigitalPayments.md +++ b/docs/InlineResponse2012SetupsPaymentsDigitalPayments.md @@ -1,9 +1,9 @@ -# InlineResponse2011SetupsPaymentsDigitalPayments +# InlineResponse2012SetupsPaymentsDigitalPayments ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**subscription_status** | [**InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus**](InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus.md) | | [optional] +**subscription_status** | [**InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus**](InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2011SetupsRisk.md b/docs/InlineResponse2012SetupsRisk.md similarity index 52% rename from docs/InlineResponse2011SetupsRisk.md rename to docs/InlineResponse2012SetupsRisk.md index d415c6c4..fb76a030 100644 --- a/docs/InlineResponse2011SetupsRisk.md +++ b/docs/InlineResponse2012SetupsRisk.md @@ -1,10 +1,10 @@ -# InlineResponse2011SetupsRisk +# InlineResponse2012SetupsRisk ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**fraud_management_essentials** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] -**decision_manager** | [**InlineResponse2011SetupsPaymentsCardProcessing**](InlineResponse2011SetupsPaymentsCardProcessing.md) | | [optional] +**fraud_management_essentials** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] +**decision_manager** | [**InlineResponse2012SetupsPaymentsCardProcessing**](InlineResponse2012SetupsPaymentsCardProcessing.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2011SetupsValueAddedServices.md b/docs/InlineResponse2012SetupsValueAddedServices.md similarity index 50% rename from docs/InlineResponse2011SetupsValueAddedServices.md rename to docs/InlineResponse2012SetupsValueAddedServices.md index 309d9d0a..924064c2 100644 --- a/docs/InlineResponse2011SetupsValueAddedServices.md +++ b/docs/InlineResponse2012SetupsValueAddedServices.md @@ -1,10 +1,10 @@ -# InlineResponse2011SetupsValueAddedServices +# InlineResponse2012SetupsValueAddedServices ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**reporting** | [**InlineResponse2011SetupsPaymentsDigitalPayments**](InlineResponse2011SetupsPaymentsDigitalPayments.md) | | [optional] -**transaction_search** | [**InlineResponse2011SetupsPaymentsDigitalPayments**](InlineResponse2011SetupsPaymentsDigitalPayments.md) | | [optional] +**reporting** | [**InlineResponse2012SetupsPaymentsDigitalPayments**](InlineResponse2012SetupsPaymentsDigitalPayments.md) | | [optional] +**transaction_search** | [**InlineResponse2012SetupsPaymentsDigitalPayments**](InlineResponse2012SetupsPaymentsDigitalPayments.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2013.md b/docs/InlineResponse2013.md index b975ad83..4e573b1e 100644 --- a/docs/InlineResponse2013.md +++ b/docs/InlineResponse2013.md @@ -3,21 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**webhook_id** | **str** | Webhook Id. This is generated by the server. | [optional] -**organization_id** | **str** | Organization ID | [optional] -**product_id** | **str** | The product you are receiving a webhook for. | [optional] -**event_types** | **list[str]** | Array of the different events for a given product id. | [optional] -**webhook_url** | **str** | The client's endpoint (URL) to receive webhooks. | [optional] -**health_check_url** | **str** | The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. | [optional] -**notification_scope** | [**Notificationsubscriptionsv1webhooksNotificationScope**](Notificationsubscriptionsv1webhooksNotificationScope.md) | | [optional] -**status** | **str** | Webhook status. | [optional] [default to 'INACTIVE'] -**name** | **str** | Client friendly webhook name. | [optional] -**description** | **str** | Client friendly webhook description. | [optional] -**retry_policy** | [**Notificationsubscriptionsv1webhooksRetryPolicy**](Notificationsubscriptionsv1webhooksRetryPolicy.md) | | [optional] -**security_policy** | [**Notificationsubscriptionsv1webhooksSecurityPolicy**](Notificationsubscriptionsv1webhooksSecurityPolicy.md) | | [optional] -**created_on** | **str** | Date on which webhook was created/registered. | [optional] -**updated_on** | **str** | Date on which webhook was most recently updated. | [optional] -**additional_attributes** | **list[dict(str, str)]** | Additional, free form configuration data. | [optional] +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - ACCEPTED | [optional] +**client_reference_information** | [**Kmsegressv2keyssymClientReferenceInformation**](Kmsegressv2keyssymClientReferenceInformation.md) | | [optional] +**key_information** | [**InlineResponse2013KeyInformation**](InlineResponse2013KeyInformation.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2012KeyInformation.md b/docs/InlineResponse2013KeyInformation.md similarity index 86% rename from docs/InlineResponse2012KeyInformation.md rename to docs/InlineResponse2013KeyInformation.md index 456a431f..ab0db7e5 100644 --- a/docs/InlineResponse2012KeyInformation.md +++ b/docs/InlineResponse2013KeyInformation.md @@ -1,4 +1,4 @@ -# InlineResponse2012KeyInformation +# InlineResponse2013KeyInformation ## Properties Name | Type | Description | Notes @@ -13,7 +13,7 @@ Name | Type | Description | Notes **status** | **str** | The status of the key | [optional] **expiration_date** | **str** | The expiration time in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] **message** | **str** | Message in case of failed key | [optional] -**error_information** | [**InlineResponse2012KeyInformationErrorInformation**](InlineResponse2012KeyInformationErrorInformation.md) | | [optional] +**error_information** | [**InlineResponse2013KeyInformationErrorInformation**](InlineResponse2013KeyInformationErrorInformation.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2012KeyInformationErrorInformation.md b/docs/InlineResponse2013KeyInformationErrorInformation.md similarity index 70% rename from docs/InlineResponse2012KeyInformationErrorInformation.md rename to docs/InlineResponse2013KeyInformationErrorInformation.md index 9197fe58..af64e651 100644 --- a/docs/InlineResponse2012KeyInformationErrorInformation.md +++ b/docs/InlineResponse2013KeyInformationErrorInformation.md @@ -1,10 +1,10 @@ -# InlineResponse2012KeyInformationErrorInformation +# InlineResponse2013KeyInformationErrorInformation ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reason** | **str** | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA | [optional] -**details** | [**list[InlineResponse2012KeyInformationErrorInformationDetails]**](InlineResponse2012KeyInformationErrorInformationDetails.md) | | [optional] +**details** | [**list[InlineResponse2013KeyInformationErrorInformationDetails]**](InlineResponse2013KeyInformationErrorInformationDetails.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2012KeyInformationErrorInformationDetails.md b/docs/InlineResponse2013KeyInformationErrorInformationDetails.md similarity index 89% rename from docs/InlineResponse2012KeyInformationErrorInformationDetails.md rename to docs/InlineResponse2013KeyInformationErrorInformationDetails.md index c2341919..f2dd4a7c 100644 --- a/docs/InlineResponse2012KeyInformationErrorInformationDetails.md +++ b/docs/InlineResponse2013KeyInformationErrorInformationDetails.md @@ -1,4 +1,4 @@ -# InlineResponse2012KeyInformationErrorInformationDetails +# InlineResponse2013KeyInformationErrorInformationDetails ## Properties Name | Type | Description | Notes diff --git a/docs/InlineResponse2014.md b/docs/InlineResponse2014.md index 1db02a75..d427df99 100644 --- a/docs/InlineResponse2014.md +++ b/docs/InlineResponse2014.md @@ -3,10 +3,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] -**status** | **str** | The status of the submitted transaction. Possible values: - ACCEPTED | [optional] -**client_reference_information** | [**Kmsegressv2keyssymClientReferenceInformation**](Kmsegressv2keyssymClientReferenceInformation.md) | | [optional] -**key_information** | [**Kmsegressv2keysasymKeyInformation**](Kmsegressv2keysasymKeyInformation.md) | | [optional] +**webhook_id** | **str** | Webhook Id. This is generated by the server. | [optional] +**organization_id** | **str** | Organization ID | [optional] +**product_id** | **str** | The product you are receiving a webhook for. | [optional] +**event_types** | **list[str]** | Array of the different events for a given product id. | [optional] +**webhook_url** | **str** | The client's endpoint (URL) to receive webhooks. | [optional] +**health_check_url** | **str** | The client's health check endpoint (URL). This should be as close as possible to the actual webhookUrl. | [optional] +**notification_scope** | [**Notificationsubscriptionsv1webhooksNotificationScope**](Notificationsubscriptionsv1webhooksNotificationScope.md) | | [optional] +**status** | **str** | Webhook status. | [optional] [default to 'INACTIVE'] +**name** | **str** | Client friendly webhook name. | [optional] +**description** | **str** | Client friendly webhook description. | [optional] +**retry_policy** | [**Notificationsubscriptionsv1webhooksRetryPolicy**](Notificationsubscriptionsv1webhooksRetryPolicy.md) | | [optional] +**security_policy** | [**Notificationsubscriptionsv1webhooksSecurityPolicy**](Notificationsubscriptionsv1webhooksSecurityPolicy.md) | | [optional] +**created_on** | **str** | Date on which webhook was created/registered. | [optional] +**updated_on** | **str** | Date on which webhook was most recently updated. | [optional] +**additional_attributes** | **list[dict(str, str)]** | Additional, free form configuration data. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/InlineResponse2015.md b/docs/InlineResponse2015.md new file mode 100644 index 00000000..8d6d12d1 --- /dev/null +++ b/docs/InlineResponse2015.md @@ -0,0 +1,13 @@ +# InlineResponse2015 + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submit_time_utc** | **str** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] +**status** | **str** | The status of the submitted transaction. Possible values: - ACCEPTED | [optional] +**client_reference_information** | [**Kmsegressv2keyssymClientReferenceInformation**](Kmsegressv2keyssymClientReferenceInformation.md) | | [optional] +**key_information** | [**Kmsegressv2keysasymKeyInformation**](Kmsegressv2keysasymKeyInformation.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md b/docs/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md index 4522a6e5..aa5083a8 100644 --- a/docs/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md +++ b/docs/Invoicingv2invoicesOrderInformationAmountDetailsFreight.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **amount** | **str** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. | [optional] -**taxable** | **bool** | 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] +**taxable** | **bool** | 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. Possible values: - **true** - **false** | [optional] **tax_rate** | **str** | 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] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails.md b/docs/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails.md index 94ea56b0..52448783 100644 --- a/docs/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails.md +++ b/docs/Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] +**type** | **str** | Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` | [optional] **amount** | **str** | Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | | ------------- |:-------------:| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of value added tax (VAT) included in the order. | | `other` | Other tax. | | `green` | Green tax amount for Korean Processing. | | [optional] -**rate** | **str** | Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] +**rate** | **str** | Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Invoicingv2invoicesOrderInformationLineItems.md b/docs/Invoicingv2invoicesOrderInformationLineItems.md index a0a01b62..707e8e60 100644 --- a/docs/Invoicingv2invoicesOrderInformationLineItems.md +++ b/docs/Invoicingv2invoicesOrderInformationLineItems.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes **product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] **product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] **quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] **discount_amount** | **str** | Discount applied to the item. | [optional] **discount_rate** | **str** | Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%) | [optional] **tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] -**tax_rate** | **str** | Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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] +**tax_rate** | **str** | Tax rate applied to the item. **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] **total_amount** | **str** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ManageWebhooksApi.md b/docs/ManageWebhooksApi.md index 31f12373..86342a4a 100644 --- a/docs/ManageWebhooksApi.md +++ b/docs/ManageWebhooksApi.md @@ -159,7 +159,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **save_asym_egress_key** -> InlineResponse2014 save_asym_egress_key(v_c_sender_organization_id, v_c_permissions, save_asym_egress_key, v_c_correlation_id=v_c_correlation_id) +> InlineResponse2015 save_asym_egress_key(v_c_sender_organization_id, v_c_permissions, save_asym_egress_key, v_c_correlation_id=v_c_correlation_id) Message Level Encryption @@ -199,7 +199,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2014**](InlineResponse2014.md) +[**InlineResponse2015**](InlineResponse2015.md) ### Authorization diff --git a/docs/MerchantBoardingApi.md b/docs/MerchantBoardingApi.md index f297e4c3..76b4000c 100644 --- a/docs/MerchantBoardingApi.md +++ b/docs/MerchantBoardingApi.md @@ -57,7 +57,7 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **post_registration** -> InlineResponse2011 post_registration(post_registration_body, v_c_idempotency_id=v_c_idempotency_id) +> InlineResponse2012 post_registration(post_registration_body, v_c_idempotency_id=v_c_idempotency_id) Create a boarding registration @@ -93,7 +93,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2011**](InlineResponse2011.md) +[**InlineResponse2012**](InlineResponse2012.md) ### Authorization diff --git a/docs/MerchantInitiatedTransactionObject.md b/docs/MerchantInitiatedTransactionObject.md index bed41eea..eeb4774c 100644 --- a/docs/MerchantInitiatedTransactionObject.md +++ b/docs/MerchantInitiatedTransactionObject.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**reason** | **str** | Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**reason** | **str** | Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code | [optional] **previous_transaction_id** | **str** | Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_ in the reply message for either the original merchant-initiated payment in the series or the previous merchant-initiated payment in the series. If the current payment request includes a token instead of an account number, the following time limits apply for the value of this field: - For a **resubmission**, the transaction ID must be less than 14 days old. - For a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] -**original_authorized_amount** | **str** | Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] +**original_authorized_amount** | **str** | Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. | [optional] **agreement_id** | **str** | This field contains the predetermined agrement id with the merchant | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation.md b/docs/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation.md index c753dcc8..4ca584d2 100644 --- a/docs/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation.md +++ b/docs/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **approval_code** | **str** | Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. | [optional] -**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] +**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] **response_code** | **str** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) | [optional] **system_trace_audit_number** | **str** | This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. Returned by authorization and incremental authorization services. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer's receipt. | [optional] **response_details** | **str** | This field might contain information about a decline. This field is supported only for **CyberSource through VisaNet**. | [optional] diff --git a/docs/PtsV2PaymentsOrderPost201ResponseProcessorInformation.md b/docs/PtsV2PaymentsOrderPost201ResponseProcessorInformation.md index 6bcdeabb..a5eb6627 100644 --- a/docs/PtsV2PaymentsOrderPost201ResponseProcessorInformation.md +++ b/docs/PtsV2PaymentsOrderPost201ResponseProcessorInformation.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **seller_protection** | [**PtsV2PaymentsOrderPost201ResponseProcessorInformationSellerProtection**](PtsV2PaymentsOrderPost201ResponseProcessorInformationSellerProtection.md) | | [optional] **avs** | [**PtsV2PaymentsPost201Response1ProcessorInformationAvs**](PtsV2PaymentsPost201Response1ProcessorInformationAvs.md) | | [optional] -**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] +**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] **response_details** | **str** | This field might contain information about a decline. This field is supported only for **CyberSource through VisaNet**. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PtsV2PaymentsPost201Response1ProcessorInformation.md b/docs/PtsV2PaymentsPost201Response1ProcessorInformation.md index 32da399b..06e9b5e4 100644 --- a/docs/PtsV2PaymentsPost201Response1ProcessorInformation.md +++ b/docs/PtsV2PaymentsPost201Response1ProcessorInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] +**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] **trade_number** | **str** | The description for this field is not available. | [optional] **raw_response** | **str** | This field is set to the value of failure reason returned by the processor. | [optional] **response_code** | **str** | This field is set to the value of response code returned by the processor. | [optional] diff --git a/docs/PtsV2PaymentsPost201Response2ProcessorInformation.md b/docs/PtsV2PaymentsPost201Response2ProcessorInformation.md index e9d95d6a..7dbcea6e 100644 --- a/docs/PtsV2PaymentsPost201Response2ProcessorInformation.md +++ b/docs/PtsV2PaymentsPost201Response2ProcessorInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] +**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] **payment_url** | **str** | Direct the customer to this URL to complete the payment. | [optional] **response_details** | **str** | This field might contain information about a decline. This field is supported only for **CyberSource through VisaNet**. | [optional] **token** | **str** | Payment gateway/processor assigned session token. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md b/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md index 0b291149..c031d5ab 100644 --- a/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md @@ -31,7 +31,7 @@ Name | Type | Description | Notes **proxy_pan** | **str** | Encrypted version of the card number used in the payer authentication request message. | [optional] **sdk_transaction_id** | **str** | SDK unique transaction identifier that is generated on each new transaction. | [optional] **signed_pares_status_reason** | **str** | Provides additional information as to why the PAResStatus has a specific value. | [optional] -**specification_version** | **str** | This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0. | [optional] +**specification_version** | **str** | This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 | [optional] **step_up_url** | **str** | The fully qualified URL that the merchant uses to post a form to the cardholder in order to complete the Consumer Authentication transaction for the Cardinal Cruise API integration. | [optional] **three_ds_server_transaction_id** | **str** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] **ucaf_authentication_data** | **str** | 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] diff --git a/docs/PtsV2PaymentsPost201ResponseInstallmentInformation.md b/docs/PtsV2PaymentsPost201ResponseInstallmentInformation.md index c802e16c..0c697f10 100644 --- a/docs/PtsV2PaymentsPost201ResponseInstallmentInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseInstallmentInformation.md @@ -3,32 +3,32 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**additional_costs** | **str** | Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs | [optional] -**additional_costs_percentage** | **str** | Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs | [optional] -**amount** | **str** | Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**amount_funded** | **str** | Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded | [optional] -**amount_requested_percentage** | **str** | Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested | [optional] -**annual_financing_cost** | **str** | Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing | [optional] -**annual_interest_rate** | **str** | Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate | [optional] -**expenses** | **str** | Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses | [optional] -**expenses_percentage** | **str** | Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses | [optional] -**fees** | **str** | Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees | [optional] -**fees_percentage** | **str** | Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees | [optional] -**frequency** | **str** | Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**insurance** | **str** | Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance | [optional] -**insurance_percentage** | **str** | Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance | [optional] -**invoice_data** | **str** | Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification | [optional] -**monthly_interest_rate** | **str** | Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate | [optional] -**plan_type** | **str** | #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) | [optional] -**sequence** | **int** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] -**taxes** | **str** | Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes | [optional] -**taxes_percentage** | **str** | Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes | [optional] -**total_amount** | **str** | Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**total_count** | **int** | Total number of installments when making payments in installments. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] +**additional_costs** | **str** | Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs | [optional] +**additional_costs_percentage** | **str** | Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs | [optional] +**amount** | **str** | Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. | [optional] +**amount_funded** | **str** | Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded | [optional] +**amount_requested_percentage** | **str** | Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested | [optional] +**annual_financing_cost** | **str** | Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing | [optional] +**annual_interest_rate** | **str** | Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate | [optional] +**expenses** | **str** | Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses | [optional] +**expenses_percentage** | **str** | Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses | [optional] +**fees** | **str** | Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees | [optional] +**fees_percentage** | **str** | Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees | [optional] +**frequency** | **str** | Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency | [optional] +**insurance** | **str** | Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance | [optional] +**insurance_percentage** | **str** | Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance | [optional] +**invoice_data** | **str** | Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification | [optional] +**monthly_interest_rate** | **str** | Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate | [optional] +**plan_type** | **str** | #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) | [optional] +**sequence** | **int** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] +**taxes** | **str** | Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes | [optional] +**taxes_percentage** | **str** | Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes | [optional] +**total_amount** | **str** | Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. | [optional] +**total_count** | **int** | Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] **minimum_total_count** | **str** | \"Minimum number of installments offered by the issuer for this purchase. The issuer provides this value when the first installment payment is successful. This field is supported for installment payments with Mastercard on CyberSource through VisaNet in all countries except Brazil, Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 75-76 - Field: Mastercard Minimum Number Of Installments | [optional] **maximum_total_count** | **str** | Maximum number of installments offered by the issuer for this purchase. The issuer provides this value when the first installment payment is successful. This field is supported for installment payments with Mastercard on CyberSource through VisaNet in all countries except Brazil, Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR5 - Position: 77-78 - Field: Mastercard Maximum Number Of Installments | [optional] **first_installment_amount** | **str** | Amount of the first installment payment. The issuer provides this value when the first installment payment is successful. This field is supported for Mastercard installment payments on CyberSource through VisaNet in all countries except Brazil,Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 23-34 - Field: Amount of Each Installment | [optional] -**first_installment_date** | **str** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional] +**first_installment_date** | **str** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PtsV2PaymentsPost201ResponseIssuerInformation.md b/docs/PtsV2PaymentsPost201ResponseIssuerInformation.md index ea4f65bb..6fee0533 100644 --- a/docs/PtsV2PaymentsPost201ResponseIssuerInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseIssuerInformation.md @@ -3,10 +3,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**country** | **str** | Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions. For details, see `auth_card_issuer_country` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**discretionary_data** | **str** | Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**country_specific_discretionary_data** | **str** | Data defined by the issuer. This national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan. This subfield contains the Katakana text to be printed on the receipt. For details, see `jpo_issuer_message` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**response_code** | **str** | This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | | .... | ... | For details, see `issuerInformation. responseCode` field description in the [Credit Card Service Using the SCMP API Guide.] (https://developer.cybersource.com/content/dam/docs/cybs/en-us/api-fields/reference/all/rest/api-fields.pdf)| | [optional] +**country** | **str** | Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions. | [optional] +**discretionary_data** | **str** | Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. | [optional] +**country_specific_discretionary_data** | **str** | Data defined by the issuer. This national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan. This subfield contains the Katakana text to be printed on the receipt. | [optional] +**response_code** | **str** | This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | | [optional] **pin_request_indicator** | **str** | This field contains value '1' which is sent by Issuer in the response when PIN is requested by issuer, This field is only supported for Visa Platform Connect. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md b/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md index 4944bd09..e36359d1 100644 --- a/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md +++ b/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**prefix** | **str** | First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_prefix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/) | [optional] -**suffix** | **str** | Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For details, see `token_suffix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/) | [optional] +**prefix** | **str** | First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] +**suffix** | **str** | Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] **type** | **str** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay - '070': EFTPOS [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] **assurance_level** | **str** | Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. Returned by PIN debit credit or PIN debit purchase. **Note** Merchants supported for **CyberSource through VisaNet**/**Visa Platform Connect** are advised not to use this field. | [optional] -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] **requestor_id** | **str** | Value that identifies your business and indicates that the cardholder's account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider's database. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. #### PIN debit Optional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional] **assurance_method** | **str** | Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **Visa Platform Connect** | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformation.md b/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformation.md index e0868d11..1b178aba 100644 --- a/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformation.md +++ b/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformation.md @@ -4,6 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **response_insights** | [**PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights**](PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights.md) | | [optional] +**orchestration** | [**PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration**](PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration.md b/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration.md new file mode 100644 index 00000000..be3d2956 --- /dev/null +++ b/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration.md @@ -0,0 +1,10 @@ +# PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**info_codes** | **list[str]** | Infocodes indicating which rules were triggered by the Service Orchestration product. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights.md b/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights.md index 0f9d00bf..481b7faf 100644 --- a/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights.md +++ b/docs/PtsV2PaymentsPost201ResponsePaymentInsightsInformationResponseInsights.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category** | **str** | Categorization of response message from processor Possible Values: - `APPROVED` - `ISSUER_WILL_NEVER_APPROVE` - `ISSUER_CANT_APPROVE_AT_THIS_TIME` - `ISSUER_CANT_APPROVE_WITH_THESE_DETAILS` - `GENERIC_ERROR` - `OTHERS` - `MATCH_NOT_FOUND` | [optional] -**category_code** | **str** | Categorization Code of response message from processor Possible Values: - `01` : Issuer Will Never Approve - `02` : Issuer Can't Approve at this Time - `03` : Issuer Can't Approve with these Details - `04` : Generic Error - `98` : Others - `99` : Payment Insights Response Category Match Not Found | [optional] +**category** | **str** | Categorization of response message from processor Possible Values: - `ISSUER_WILL_NEVER_APPROVE` - `ISSUER_CANNOT_APPROVE_AT_THIS_TIME` - `ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS` - `GENERIC_ERROR` - `PAYMENT_INSIGHTS_INTERNAL_ERROR` - `OTHERS` - `PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND` | [optional] +**category_code** | **str** | Categorization Code of response message from processor Possible Values: - `01` : ISSUER_WILL_NEVER_APPROVE - `02` : ISSUER_CANNOT_APPROVE_AT_THIS_TIME - `03` : ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS - `04` : GENERIC_ERROR - `97` : PAYMENT_INSIGHTS_INTERNAL_ERROR - `98` : OTHERS - `99` : PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND | [optional] **processor_raw_name** | **str** | Raw name of the processor used for the transaction processing, especially useful during acquirer swing to see which processor transaction settled with | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PtsV2PaymentsPost201ResponsePointOfSaleInformation.md b/docs/PtsV2PaymentsPost201ResponsePointOfSaleInformation.md index 615adf99..a9f5f6c2 100644 --- a/docs/PtsV2PaymentsPost201ResponsePointOfSaleInformation.md +++ b/docs/PtsV2PaymentsPost201ResponsePointOfSaleInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **emv** | [**PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv**](PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.md) | | [optional] -**amex_capn_data** | **str** | Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**amex_capn_data** | **str** | Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. | [optional] **terminal_id** | **str** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource through VisaNet A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. When you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by **Authorization** Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PtsV2PaymentsPost201ResponseProcessingInformation.md b/docs/PtsV2PaymentsPost201ResponseProcessingInformation.md index c662d74a..aae06f30 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessingInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessingInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bank_transfer_options** | [**PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions**](PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.md) | | [optional] -**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] +**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **enhanced_data_enabled** | **bool** | The possible values for the reply field are: - `true` : the airline data was included in the request to the processor. - `false` : the airline data was not included in the request to the processor. Returned by authorization, capture, or credit services. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md index a1c88624..a229305a 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes **auth_indicator** | **str** | Flag that specifies the purpose of the authorization. Possible values: - `0`: Preauthorization - `1`: Final authorization | [optional] **approval_code** | **str** | Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000. | [optional] **card_reference_data** | **str** | The Scheme reference data is a variable length data element up to a maximum of 56 characters. It may be sent by the acquirer in the authorisation response message, and by the terminal (unchanged) in subsequent authorisation request messages associated with the same transaction. This field is used by Streamline and HSBC UK only, at present. | [optional] -**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] +**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] **network_transaction_id** | **str** | Same value as `processorInformation.transactionId` | [optional] **response_code** | **str** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field. String (3) | [optional] **response_code_source** | **str** | Used by Visa only and contains the response source/reason code that identifies the source of the response decision. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md index 49357ae9..ca52f90b 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **str** | - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | For processor-specific information, see the `auth_merchant_advice_code` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**code_raw** | **str** | Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code For processor-specific information, see the `auth_merchant_advice_code_raw` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**code** | **str** | - Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed. - Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic. - In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value. #### Processors supported: - HSBC - Barclays - FDC Nash - FDI Global - Elavon America - VPC - Rede - Payment tech Salem #### Possible values: | Card Type | Advice Code | Description | | ----------- | ------------- | ------------------------------------------- | | VISA | 1 | Issuer never approves | | VISA | 2 | Issuer cannot approve at this time | | VISA | 3 | Data quality/revalidate payment information | | MasterCard | 01 | New account information available | | MasterCard | 02 | Try Again Later | | MasterCard | 03 | Do Not Try Again | | MasterCard | 04 | Token not supported | | MasterCard | 21 | Do not honor | | MasterCard | 22 | Merchant does not qualify for product code | | MasterCard | 24 | Retry after 1 hour | | MasterCard | 25 | Retry after 24 hours | | MasterCard | 26 | Retry after 2 days | | MasterCard | 27 | Retry after 4 days | | MasterCard | 28 | Retry after 6 days | | MasterCard | 29 | Retry after 8 days | | MasterCard | 30 | Retry after 10 days | | MasterCard | 40 | Consumer non-reloadable prepaid card | | MasterCard | 41 | Consumer single-use virtual card number | | MasterCard | 42 | Sanctions score exceeds threshold value | | MasterCard | 99 | Do Not Try Again | | [optional] +**code_raw** | **str** | Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code | [optional] **name_match** | **str** | #### Visa Platform Connect The field contains will contain the Account Name Request Result for zero amount Authorization request. Valid values are: 00 = Name Match Performed 01 = Name Match not Performed 02 = Name Match not supported | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/PtsV2PaymentsReversalsPost201ResponseIssuerInformation.md b/docs/PtsV2PaymentsReversalsPost201ResponseIssuerInformation.md index 49205cbf..955336dd 100644 --- a/docs/PtsV2PaymentsReversalsPost201ResponseIssuerInformation.md +++ b/docs/PtsV2PaymentsReversalsPost201ResponseIssuerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**response_code** | **str** | This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | | .... | ... | For details, see `issuerInformation. responseCode` field description in the [Credit Card Service Using the SCMP API Guide.] (https://developer.cybersource.com/content/dam/docs/cybs/en-us/api-fields/reference/all/rest/api-fields.pdf)| | [optional] +**response_code** | **str** | This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions. #### Processors supported: - HSBC - FDC Nashville Global - SIX Currently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor. #### Possible values: | Card Type | Response Code | Description | | ----------- | ------------- | ------------------------------------------------------------------------------ | | VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful | | VISA | 001 | Refer to card issuer | | VISA | 002 | Refer to card issuer, special condition | | VISA | 003 | Invalid merchant or service provider | | VISA | 004 | Pickup card | | MasterCard | 000 | Approved or completed successfully | | MasterCard | 001 | Refer to card issuer | | MasterCard | 003 | Invalid merchant | | MasterCard | 004 | Capture card | | MasterCard | 005 | Do not honor | | AMEX | 000 | Approved | | AMEX | 001 | Approve with ID | | AMEX | 002 | Partial Approval (Prepaid Cards only) | | AMEX | 100 | Deny | | AMEX | 101 | Expired Card/Invalid Expiration Date | | Discover | 000 | Approved or completed successfully | | Discover | 001 | Reserved for future USE | | Discover | 002 | Reserved for future USE | | Discover | 003 | Invalid Merchant | | Discover | 004 | Capture Card | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv1pushfundstransferProcessingInformation.md b/docs/Ptsv1pushfundstransferProcessingInformation.md index f5312896..7413c03e 100644 --- a/docs/Ptsv1pushfundstransferProcessingInformation.md +++ b/docs/Ptsv1pushfundstransferProcessingInformation.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **business_application_id** | **str** | Payouts transaction type. Business Application ID: - `PP`: Person to person. - `FD`: Funds disbursement (general) | [optional] **payouts_options** | [**Ptsv1pushfundstransferProcessingInformationPayoutsOptions**](Ptsv1pushfundstransferProcessingInformationPayoutsOptions.md) | | [optional] +**enabler_id** | **str** | Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2billingagreementsBuyerInformation.md b/docs/Ptsv2billingagreementsBuyerInformation.md index 56d8df40..7739a344 100644 --- a/docs/Ptsv2billingagreementsBuyerInformation.md +++ b/docs/Ptsv2billingagreementsBuyerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchant_customer_id** | **str** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### SEPA/BACS Required for Create Mandate and Import Mandate #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchant_customer_id** | **str** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### SEPA/BACS Required for Create Mandate and Import Mandate #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. | [optional] **date_of_birth** | **str** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] **gender** | **str** | Customer's gender. Possible values are F (female), M (male), O (other). | [optional] **language** | **str** | language setting of the user | [optional] diff --git a/docs/Ptsv2billingagreementsInstallmentInformation.md b/docs/Ptsv2billingagreementsInstallmentInformation.md index cfdea5ce..158e6be8 100644 --- a/docs/Ptsv2billingagreementsInstallmentInformation.md +++ b/docs/Ptsv2billingagreementsInstallmentInformation.md @@ -4,14 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **alert_preference** | **str** | Applicable only for SI. Required in case the authentication is initiated for SI registration. Valid Values: - `SMS` - `EMAIL` - `BOTH` | [optional] -**first_installment_date** | **str** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional] +**first_installment_date** | **str** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional] **identifier** | **str** | Standing Instruction/Installment identifier. | [optional] **last_installment_date** | **str** | End date of the SI transactions. Cannot be later than card expiry date. Ideally this can be set to expiry date. Required in case the authentication is initiated for SI registration. | [optional] **max_amount** | **str** | Maximum Amount for which SI can be initiated. Required in case the authentication is initiated for SI registration. | [optional] **min_amount** | **str** | Minimum Amount for which SI can be initiated. Required in case the authentication is initiated for SI registration. | [optional] -**payment_type** | **str** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional] +**payment_type** | **str** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional] **preferred_day** | **str** | Preferred date for initiating the SI transaction every month. This field need not be sent in case the SI has to be initiated as and when required, e.g., topping up the wallet, etc. | [optional] -**sequence** | **int** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] +**sequence** | **int** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2billingagreementsMerchantInformation.md b/docs/Ptsv2billingagreementsMerchantInformation.md index 1677d52d..4fd8a747 100644 --- a/docs/Ptsv2billingagreementsMerchantInformation.md +++ b/docs/Ptsv2billingagreementsMerchantInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **merchant_descriptor** | [**Ptsv2billingagreementsMerchantInformationMerchantDescriptor**](Ptsv2billingagreementsMerchantInformationMerchantDescriptor.md) | | [optional] -**category_code** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] +**category_code** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] **administrative_area** | **str** | The state where the merchant is located. #### PIN debit State code or region code for your business. Use the 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) This value might be displayed on the cardholder's statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. Optional field for PIN debit credit or PIN debit purchase. | [optional] **transaction_local_date_time** | **str** | Date and time at your physical location. Format: `YYYYMMDDhhmmss`, where: - `YYYY` = year - `MM` = month - `DD` = day - `hh` = hour - `mm` = minutes - `ss` = seconds #### Used by **Authorization** Required for these processors: - American Express Direct - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX Optional for all other processors. | [optional] **cancel_url** | **str** | URL to which the customer is directed if they fail to sign the mandate. #### SEPA Required for Create Mandate and Update Mandate #### BACS Required for Create Mandate | [optional] diff --git a/docs/Ptsv2billingagreementsMerchantInformationMerchantDescriptor.md b/docs/Ptsv2billingagreementsMerchantInformationMerchantDescriptor.md index ffb82ac8..fb8f8851 100644 --- a/docs/Ptsv2billingagreementsMerchantInformationMerchantDescriptor.md +++ b/docs/Ptsv2billingagreementsMerchantInformationMerchantDescriptor.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **postal_code** | **str** | Merchant's postal code. #### PIN debit Postal code for your business location. This value might be displayed on the cardholder's statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: `12345-6789` If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: `A1B 2C3` When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. **Important** Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your account or you can include this field in your request. Optional field for PIN debit credit or PIN debit purchase. | [optional] -**contact** | **str** | For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) | [optional] +**contact** | **str** | Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) | [optional] **locality** | **str** | Merchant's City. #### PIN debit City for your business location. This value might be displayed on the cardholder's statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. | [optional] **name** | **str** | Your merchant name. **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. **Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field. **Important** This value must consist of English characters. Required for captures and credits. | [optional] diff --git a/docs/Ptsv2billingagreementsPaymentInformationTokenizedCard.md b/docs/Ptsv2billingagreementsPaymentInformationTokenizedCard.md index 936b5155..8199c109 100644 --- a/docs/Ptsv2billingagreementsPaymentInformationTokenizedCard.md +++ b/docs/Ptsv2billingagreementsPaymentInformationTokenizedCard.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **cryptogram** | **str** | This field contains token information. | [optional] -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] **number** | **str** | Customer's payment network token value. | [optional] **transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | [optional] **type** | **str** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay - '070': EFTPOS [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] diff --git a/docs/Ptsv2creditsInstallmentInformation.md b/docs/Ptsv2creditsInstallmentInformation.md index e42d59e5..eff46559 100644 --- a/docs/Ptsv2creditsInstallmentInformation.md +++ b/docs/Ptsv2creditsInstallmentInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**plan_type** | **str** | #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) | [optional] +**plan_type** | **str** | #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2creditsProcessingInformation.md b/docs/Ptsv2creditsProcessingInformation.md index f445dccd..358f255f 100644 --- a/docs/Ptsv2creditsProcessingInformation.md +++ b/docs/Ptsv2creditsProcessingInformation.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **commerce_indicator** | **str** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] **processor_id** | **str** | Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. Contact CyberSource Customer Support to get the value for this field. | [optional] -**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] +**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **reconciliation_id** | **str** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] **link_id** | **str** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] **report_group** | **str** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] diff --git a/docs/Ptsv2paymentreferencesOrderInformationLineItems.md b/docs/Ptsv2paymentreferencesOrderInformationLineItems.md index ea46a4f6..5f5448cb 100644 --- a/docs/Ptsv2paymentreferencesOrderInformationLineItems.md +++ b/docs/Ptsv2paymentreferencesOrderInformationLineItems.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes **product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] **product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] **quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] **discount_amount** | **str** | Discount applied to the item. | [optional] **discount_rate** | **str** | Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%) | [optional] **tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] -**tax_rate** | **str** | Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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] +**tax_rate** | **str** | Tax rate applied to the item. **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] **total_amount** | **str** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional] -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] **product_description** | **str** | Brief description of item. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentreferencesOrderInformationShipTo.md b/docs/Ptsv2paymentreferencesOrderInformationShipTo.md index fff14b44..ff7dbefa 100644 --- a/docs/Ptsv2paymentreferencesOrderInformationShipTo.md +++ b/docs/Ptsv2paymentreferencesOrderInformationShipTo.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **first_name** | **str** | First name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] **middle_name** | **str** | Middle name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] **last_name** | **str** | Last name of the recipient. #### Litle Maximum length: 25 #### All other processors Maximum length: 60 Optional field. | [optional] -**company** | **str** | Name of the customer's company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**company** | **str** | Name of the customer's company. | [optional] **address1** | **str** | First line of the shipping address. Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] **address2** | **str** | Second line of the shipping address. Optional field. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] **district** | **str** | Neighborhood, community, or region within a city or municipality. | [optional] diff --git a/docs/Ptsv2paymentsAggregatorInformationSubMerchant.md b/docs/Ptsv2paymentsAggregatorInformationSubMerchant.md index 016005d4..d634c987 100644 --- a/docs/Ptsv2paymentsAggregatorInformationSubMerchant.md +++ b/docs/Ptsv2paymentsAggregatorInformationSubMerchant.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes **card_acceptor_id** | **str** | Unique identifier assigned by the payment card company to the sub-merchant. | [optional] **id** | **str** | The ID you assigned to your sub-merchant. CyberSource through VisaNet: For American Express transaction, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 65-84 - Field: American Express Seller ID For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 117-131 - Field: Sub-Merchant ID FDC Compass: This value must consist of uppercase characters. American Express Direct: String (20) CyberSource through VisaNet with American Express: String (20) CyberSource through VisaNet with Visa,Mastercard and Discover: String (15) FDC Compass: String (20) FDC Nashville Global: String (14) | [optional] **name** | **str** | Sub-merchant's business name. #### American Express Direct The maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. #### CyberSource through VisaNet With American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. | [optional] -**address1** | **str** | First line of the sub-merchant's street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**locality** | **str** | Sub-merchant's city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**administrative_area** | **str** | Sub-merchant's state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**region** | **str** | Sub-merchant's region. **Example**\\ `NE` indicates that the sub-merchant is in the northeast region. For processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**postal_code** | **str** | Partial postal code for the sub-merchant's address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**country** | **str** | Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. For details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**address1** | **str** | First line of the sub-merchant's street address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**locality** | **str** | Sub-merchant's city. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**administrative_area** | **str** | Sub-merchant's state or province. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**region** | **str** | Sub-merchant's region. **Example**\\ `NE` indicates that the sub-merchant is in the northeast region. | [optional] +**postal_code** | **str** | Partial postal code for the sub-merchant's address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**country** | **str** | Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. | [optional] **email** | **str** | Sub-merchant's email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] **phone_number** | **str** | Sub-merchant's telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` | [optional] diff --git a/docs/Ptsv2paymentsConsumerAuthenticationInformation.md b/docs/Ptsv2paymentsConsumerAuthenticationInformation.md index a0c8c5fb..da6ef50f 100644 --- a/docs/Ptsv2paymentsConsumerAuthenticationInformation.md +++ b/docs/Ptsv2paymentsConsumerAuthenticationInformation.md @@ -13,8 +13,8 @@ Name | Type | Description | Notes **ucaf_collection_indicator** | **str** | Universal cardholder authentication field (UCAF) collection indicator. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR7 - Position: 5 - Field: Mastercard Electronic Commerce Indicators—UCAF Collection Indicator | [optional] **ucaf_authentication_data** | **str** | Universal cardholder authentication field (UCAF) data. | [optional] **strong_authentication** | [**Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication**](Ptsv2paymentsConsumerAuthenticationInformationStrongAuthentication.md) | | [optional] -**directory_server_transaction_id** | **str** | 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] -**pa_specification_version** | **str** | This field contains 3DS version that was used for Secured Consumer Authentication (SCA). For example 3DS secure version 1.0.2 or 2.0.0 is used for Secured Consumer Authentication. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 113 , Field: MC AVV Verification—Program Protocol It will contain one of the following values: - `1` (3D Secure Version 1.0 (3DS 1.0)) - `2` (EMV 3-D Secure (3DS 2.0)) For Cybersource connection through Visanet, below are additional values to be supported. - `2.1.0` (EMV 3D Secure Version 2.1) - `2.2.0` (EMV 3D Secure Version 2.2) - `2.3.0` (EMV 3D Secure Version 2.3) - `2.4.0` (EMV 3D Secure Version 2.4) - `2.5.0` (EMV 3D Secure Version 2.5) - `2.6.0` (EMV 3D Secure Version 2.6) - `2.7.0` (EMV 3D Secure Version 2.7) - `2.8.0` (EMV 3D Secure Version 2.8) - `2.9.0` (EMV 3D Secure Version 2.9) | [optional] +**directory_server_transaction_id** | **str** | 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] +**pa_specification_version** | **str** | This field contains 3DS version that was used for Secured Consumer Authentication (SCA). The value for this field should be in the format major.minor.patch version. Valid Values are: - `2.1.0` (EMV 3D Secure Version 2.1) - `2.2.0` (EMV 3D Secure Version 2.2) - `2.3.0` (EMV 3D Secure Version 2.3) - `2.4.0` (EMV 3D Secure Version 2.4) - `2.5.0` (EMV 3D Secure Version 2.5) - `2.6.0` (EMV 3D Secure Version 2.6) - `2.7.0` (EMV 3D Secure Version 2.7) - `2.8.0` (EMV 3D Secure Version 2.8) - `2.9.0` (EMV 3D Secure Version 2.9) For Visa Platform Connect: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 113 , Field: MC AVV Verification—Program Protocol It will contain one of the following values: - `1` (3D Secure Version 1.x (3DS 1.0)) - `2` (EMV 3-D Secure (3DS 2.x)) | [optional] **authentication_type** | **str** | Indicates the type of authentication that will be used to challenge the card holder. Possible Values: 01 - Static 02 - Dynamic 03 - OOB (Out of Band) 04 - Decoupled 20 - OTP hosted at merchant end. (Rupay S2S flow) **NOTE**: EMV 3-D Secure version 2.1.0 supports values 01-03. Version 2.2.0 supports values 01-04. Decoupled authentication is not supported at this time. | [optional] **response_access_token** | **str** | JWT returned by the 3D Secure provider when the authentication is complete. Required for Hybrid integration if you use the Cybersource-generated access token. Note: Max. length of this field is 2048 characters. | [optional] **acs_transaction_id** | **str** | Unique transaction identifier assigned by the ACS to identify a single transaction. This field is supported for Cartes Bancaires Fast'R transactions on Credit Mutuel-CIC. | [optional] diff --git a/docs/Ptsv2paymentsInstallmentInformation.md b/docs/Ptsv2paymentsInstallmentInformation.md index 39b937bd..b2ce21a1 100644 --- a/docs/Ptsv2paymentsInstallmentInformation.md +++ b/docs/Ptsv2paymentsInstallmentInformation.md @@ -3,16 +3,16 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**amount** | **str** | Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**frequency** | **str** | Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**plan_type** | **str** | #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) | [optional] -**sequence** | **int** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] -**total_amount** | **str** | Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**total_count** | **int** | Total number of installments when making payments in installments. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] -**first_installment_date** | **str** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional] -**invoice_data** | **str** | Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification | [optional] -**payment_type** | **str** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional] -**eligibility_inquiry** | **str** | Indicates whether the authorization request is a Crediario eligibility inquiry. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. | [optional] +**amount** | **str** | Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. | [optional] +**frequency** | **str** | Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency | [optional] +**plan_type** | **str** | #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) | [optional] +**sequence** | **int** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] +**total_amount** | **str** | Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. | [optional] +**total_count** | **int** | Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] +**first_installment_date** | **str** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional] +**invoice_data** | **str** | Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification | [optional] +**payment_type** | **str** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional] +**eligibility_inquiry** | **str** | Indicates whether the authorization request is a Crediario eligibility inquiry. Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. | [optional] **grace_period_duration** | **str** | Grace period requested by the customer before the first installment payment is due. When you include this field in a request, you must also include the grace period duration type field. The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR5, Position: 100-101, Field: Mastercard Grace Period Details. This field is supported only for Mastercard installment payments in Brazil and Greece. | [optional] **grace_period_duration_type** | **str** | Unit for the requested grace period duration. Possible values: - `D`: Days - `W`: Weeks - `M`: Months The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR5, Position: 99, Field: Mastercard Grace Period Details This field is supported only for Mastercard installment payments in Brazil and Greece on CyberSource through VisaNet. | [optional] **first_installment_amount** | **str** | Amount of the first installment payment. The issuer provides this value when the first installment payment is successful. This field is supported for Mastercard installment payments on CyberSource through VisaNet in all countries except Brazil,Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 23-34 - Field: Amount of Each Installment | [optional] diff --git a/docs/Ptsv2paymentsIssuerInformation.md b/docs/Ptsv2paymentsIssuerInformation.md index c7097f02..6ac061b4 100644 --- a/docs/Ptsv2paymentsIssuerInformation.md +++ b/docs/Ptsv2paymentsIssuerInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**discretionary_data** | **str** | Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**discretionary_data** | **str** | Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsMerchantInformation.md b/docs/Ptsv2paymentsMerchantInformation.md index 306c2b81..803ff116 100644 --- a/docs/Ptsv2paymentsMerchantInformation.md +++ b/docs/Ptsv2paymentsMerchantInformation.md @@ -5,12 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **merchant_descriptor** | [**Ptsv2paymentsMerchantInformationMerchantDescriptor**](Ptsv2paymentsMerchantInformationMerchantDescriptor.md) | | [optional] **domain_name** | **str** | This field will contain either the merchant url or the reverse domain as per the requirement for DSRP Format 3. This might vary transaction to transaction and might not be static. Merchant needs to have access to send this value for all DSRP program. | [optional] -**sales_organization_id** | **str** | Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Independent Sales Organization ID This field is supported for Visa, Mastercard and Discover Transactions. **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**category_code** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] +**sales_organization_id** | **str** | Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Independent Sales Organization ID This field is supported for Visa, Mastercard and Discover Transactions. **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] +**category_code** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] **category_code_domestic** | **int** | Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. Including this field in a request for a domestic transaction might reduce interchange fees. When you include this field in a request: - Do not include the `merchant_category_code` field. - The value for this field overrides the value in your CyberSource account. This field is supported only for: - Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country. - Merchants enrolled in the OmniPay Direct interchange program. - First Data Merchant Solutions (Europe) on OmniPay Direct. | [optional] -**tax_id** | **str** | Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**card_acceptor_reference_number** | **str** | Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**tax_id** | **str** | Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 | [optional] +**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. | [optional] +**card_acceptor_reference_number** | **str** | Reference number that facilitates card acceptor/corporation communication and record keeping. | [optional] **transaction_local_date_time** | **str** | Date and time at your physical location. Format: `YYYYMMDDhhmmss`, where: - `YYYY` = year - `MM` = month - `DD` = day - `hh` = hour - `mm` = minutes - `ss` = seconds #### Used by **Authorization** Required for these processors: - American Express Direct - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX Optional for all other processors. | [optional] **service_fee_descriptor** | [**Ptsv2paymentsMerchantInformationServiceFeeDescriptor**](Ptsv2paymentsMerchantInformationServiceFeeDescriptor.md) | | [optional] **cancel_url** | **str** | customer would be redirected to this url based on the decision of the transaction | [optional] diff --git a/docs/Ptsv2paymentsMerchantInformationMerchantDescriptor.md b/docs/Ptsv2paymentsMerchantInformationMerchantDescriptor.md index ca992b7d..c2e5db6c 100644 --- a/docs/Ptsv2paymentsMerchantInformationMerchantDescriptor.md +++ b/docs/Ptsv2paymentsMerchantInformationMerchantDescriptor.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Your merchant name. **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22. #### PIN debit Your business name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. #### Airline processing Your merchant name. This name is displayed on the cardholder's statement. When you include more than one consecutive space, extra spaces are removed. **Note** Some airline fee programs may require the original ticket number (ticket identifier) or the ancillary service description in positions 13 through 23 of this field. **Important** This value must consist of English characters. Required for captures and credits. | [optional] -**alternate_name** | **str** | An alternate name for the merchant. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> | [optional] -**contact** | **str** | For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) | [optional] -**address1** | **str** | First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**alternate_name** | **str** | An alternate name for the merchant. | [optional] +**contact** | **str** | Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) | [optional] +**address1** | **str** | First line of merchant's address. | [optional] **locality** | **str** | Merchant's City. #### PIN debit City for your business location. This value might be displayed on the cardholder's statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. Optional field for PIN debit credit or PIN debit purchase requests. | [optional] **country** | **str** | Merchant's country. #### PIN debit Country code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This value might be displayed on the cardholder's statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** If your business is located in the U.S. or Canada and you include this field in a request, you must also include `merchantInformation.merchantDescriptor.administrativeArea`. Optional field for PIN debit credit or PIN debit purchase. | [optional] **postal_code** | **str** | Merchant's postal code. #### PIN debit Postal code for your business location. This value might be displayed on the cardholder's statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: `12345-6789` If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: `A1B 2C3` When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. **Important** Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your account or you can include this field in your request. Optional field for PIN debit credit or PIN debit purchase. | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationAmountDetails.md b/docs/Ptsv2paymentsOrderInformationAmountDetails.md index 79998501..3d1a325d 100644 --- a/docs/Ptsv2paymentsOrderInformationAmountDetails.md +++ b/docs/Ptsv2paymentsOrderInformationAmountDetails.md @@ -31,6 +31,7 @@ Name | Type | Description | Notes **cashback_amount** | **str** | Cashback amount in the acquirer's currency. If a cashback amount is included in the request, it must be included in the `orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization** Optional. **Authorization Reversal** Optional. #### PIN debit Optional field for PIN debit purchase, PIN debit credit or PIN debit reversal. | [optional] **currency_conversion** | [**Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion**](Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion.md) | | [optional] **order** | [**Ptsv2paymentsOrderInformationAmountDetailsOrder**](Ptsv2paymentsOrderInformationAmountDetailsOrder.md) | | [optional] +**anticipated_amount** | **str** | This API Field contains the anticipated amount details. This supports use cases where the Merchant does not wish to have funds held against the account, but needs to confirm an amount prior to authorization, such as for a trial subscription, reservation service, or loyalty program. In an account verification, the anticipated amount is used to confirm the account has availability to accept purchases. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsOrderInformationAmountDetailsOrder.md b/docs/Ptsv2paymentsOrderInformationAmountDetailsOrder.md index 773ee743..4c1c12a7 100644 --- a/docs/Ptsv2paymentsOrderInformationAmountDetailsOrder.md +++ b/docs/Ptsv2paymentsOrderInformationAmountDetailsOrder.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **handling_amount** | **str** | Aggregate handling charges for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. | [optional] **shipping_amount** | **str** | Aggregate shipping charges for the transaction If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. | [optional] **shipping_discount_amount** | **str** | Shipping discount amount for the transaction. If this amount has changed since the initial sessions request, you must include the new value in the order request. You must also include all additional amount fields that apply to the order and ensure the total amount equals the purchaseTotals_grandTotalAmount value. | [optional] -**tax_amount** | **str** | Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation. | [optional] +**tax_amount** | **str** | Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation. | [optional] **insurance_amount** | **str** | Amount being charged for the insurance fee. Only supported when the payment_method is set to paypal. | [optional] **gift_wrap_amount** | **str** | Amount being charged as gift wrap fee. | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.md b/docs/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.md index 0b63f243..6220991f 100644 --- a/docs/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.md +++ b/docs/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.md @@ -3,13 +3,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] +**type** | **str** | Indicates the type of tax data for the _taxDetails_ object. Possible values: - `alternate` - `local` - `national` - `vat` - `other` - `green` | [optional] **amount** | **str** | Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | | ------------- |:-------------:| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of value added tax (VAT) included in the order. | | `other` | Other tax. | | `green` | Green tax amount for Korean Processing. | | [optional] -**rate** | **str** | Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] -**code** | **str** | Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` | [optional] -**tax_id** | **str** | Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. For processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] -**applied** | **bool** | Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. For processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] -**exemption_code** | **str** | Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. For possible values and important information for using this field, see _Appendix B, \"Exemption Status Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] +**rate** | **str** | Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) | [optional] +**code** | **str** | Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` | [optional] +**tax_id** | **str** | Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. | [optional] +**applied** | **bool** | Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. | [optional] +**exemption_code** | **str** | Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsOrderInformationInvoiceDetails.md b/docs/Ptsv2paymentsOrderInformationInvoiceDetails.md index eb0f06ca..28120a6b 100644 --- a/docs/Ptsv2paymentsOrderInformationInvoiceDetails.md +++ b/docs/Ptsv2paymentsOrderInformationInvoiceDetails.md @@ -6,15 +6,15 @@ Name | Type | Description | Notes **invoice_number** | **str** | Invoice Number. | [optional] **barcode_number** | **str** | Barcode Number. | [optional] **expiration_date** | **str** | Expiration Date. | [optional] -**purchase_order_number** | **str** | Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the `user_po` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**purchase_order_date** | **str** | Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the `purchaser_order_date` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**purchase_contact_name** | **str** | The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the `authorized_contact_name` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxable** | **bool** | 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] -**vat_invoice_reference_number** | **str** | VAT invoice number associated with the transaction. For processor-specific information, see the `vat_invoice_ref_number` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**commodity_code** | **str** | International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the `summary_commodity_code` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**purchase_order_number** | **str** | Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. | [optional] +**purchase_order_date** | **str** | Date the order was processed. `Format: YYYY-MM-DD`. | [optional] +**purchase_contact_name** | **str** | The name of the individual or the company contacted for company authorized purchases. | [optional] +**taxable** | **bool** | 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. Possible values: - **true** - **false** | [optional] +**vat_invoice_reference_number** | **str** | VAT invoice number associated with the transaction. | [optional] +**commodity_code** | **str** | International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. | [optional] **merchandise_code** | **int** | Identifier for the merchandise. This field is supported only on the processors listed in this field description. #### American Express Direct Possible value: - 1000: Gift card #### CyberSource through VisaNet This value must be right justified. In Japan, this value is called a _goods code_. #### JCN Gateway This value must be right justified. In Japan, this value is called a _goods code_. | [optional] **transaction_advice_addendum** | [**list[Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum]**](Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.md) | | [optional] -**reference_data_code** | **str** | Code that identifies the value of the `referenceDataNumber` field. For the possible values, see \"Reference Data Codes\" in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/). This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. | [optional] +**reference_data_code** | **str** | Code that identifies the value of the `referenceDataNumber` field. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. | [optional] **reference_data_number** | **str** | Reference number. The meaning of this value is identified by the value of the `referenceDataCode` field. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. | [optional] **sales_slip_number** | **int** | Transaction identifier that is generated. You have the option of printing the sales slip number on the receipt. This field is supported only on Cybersource through Visanet and JCN gateway. Optional field. #### Card Present processing message If you included this field in the request, the returned value is the value that you sent in the request. If you did not include this field in the request, the system generated this value for you. The difference between this reply field and the `processorInformation.systemTraceAuditNumber` field is that the system generates the system trace audit number (STAN), and you must print the receipt number on the receipt; whereas you can generate the sales slip number, and you can choose to print the sales slip number on the receipt. | [optional] **invoice_date** | **str** | Date of the tax calculation. Use format YYYYMMDD. You can provide a date in the past if you are calculating tax for a refund and want to know what the tax was on the date the order was placed. You can provide a date in the future if you are calculating the tax for a future date, such as an upcoming tax holiday. The default is the date, in Pacific time, that the bank receives the request. Keep this in mind if you are in a different time zone and want the tax calculated with the rates that are applicable on a specific date. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationLineItems.md b/docs/Ptsv2paymentsOrderInformationLineItems.md index 92de9651..0db4ccb9 100644 --- a/docs/Ptsv2paymentsOrderInformationLineItems.md +++ b/docs/Ptsv2paymentsOrderInformationLineItems.md @@ -3,18 +3,18 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] **product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] **product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] **quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] **unit_of_measure** | **str** | Unit of measure, or unit of measure code, for the item. | [optional] **total_amount** | **str** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional] **tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] -**tax_rate** | **str** | Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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] +**tax_rate** | **str** | Tax rate applied to the item. **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] **tax_applied_after_discount** | **str** | Flag to indicate how you handle discount at the line item level. - 0: no line level discount provided - 1: tax was calculated on the post-discount line item total - 2: tax was calculated on the pre-discount line item total `Note` Visa will inset 0 (zero) if an invalid value is included in this field. This field relates to the value in the _lineItems[].discountAmount_ field. | [optional] **tax_status_indicator** | **str** | Flag to indicate whether tax is exempted or not included. - 0: tax not included - 1: tax included - 2: transaction is not subject to tax | [optional] -**tax_type_code** | **str** | Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` | [optional] +**tax_type_code** | **str** | Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` | [optional] **amount_includes_tax** | **bool** | Flag that indicates whether the tax amount is included in the Line Item Total. Possible values: - **true** - **false** | [optional] **type_of_supply** | **str** | Flag to indicate whether the purchase is categorized as goods or services. Possible values: - 00: goods - 01: services | [optional] **commodity_code** | **str** | Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes. | [optional] @@ -24,14 +24,14 @@ Name | Type | Description | Notes **invoice_number** | **str** | Field to support an invoice number for a transaction. You must specify the number of line items that will include an invoice number. By default, the first line item will include an invoice number field. The invoice number field can be included for up to 10 line items. | [optional] **tax_details** | [**list[Ptsv2paymentsOrderInformationAmountDetailsTaxDetails]**](Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional] **fulfillment_type** | **str** | Information about the product code used for the line item. Possible values: - `E`: The product code is `electronic_software`. - `P`: The product code is not `electronic_software`. For details, see the `fulfillmentType` field description in [Business Center Reporting User Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/reporting_and_reconciliation/Reporting_User/html/) | [optional] -**weight** | **str** | Weight of the item. For details, see `weight_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] -**weight_identifier** | **str** | Type of weight. Possible values: - B: Billed weight - N: Actual net weight For details, see `weight_identifier` offer-level field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] -**weight_unit** | **str** | Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC). For details, see `weight_unit_measurement` offer-level field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] -**reference_data_code** | **str** | Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field. Possible values: - AN: Client-defined asset code - MG: Manufacturer's part number - PO: Purchase order number - SK: Supplier stock keeping unit number - UP: Universal product code - VC: Supplier catalog number - VP: Vendor part number This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. For details, see `reference_data_#_code` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] +**weight** | **str** | Weight of the item. | [optional] +**weight_identifier** | **str** | Type of weight. Possible values: - B: Billed weight - N: Actual net weight | [optional] +**weight_unit** | **str** | Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC). | [optional] +**reference_data_code** | **str** | Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field. Possible values: - AN: Client-defined asset code - MG: Manufacturer's part number - PO: Purchase order number - SK: Supplier stock keeping unit number - UP: Universal product code - VC: Supplier catalog number - VP: Vendor part number This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. | [optional] **reference_data_number** | **str** | Reference number. The meaning of this value is identified by the value of the corresponding `referenceDataCode` field. See Numbered Elements. The maximum length for this field depends on the value of the corresponding `referenceDataCode` field: - When the code is `PO`, the maximum length for the reference number is 22. - When the code is `VC`, the maximum length for the reference number is 20. - For all other codes, the maximum length for the reference number is 30. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. | [optional] **unit_tax_amount** | **str** | Per-item tax amount of the product. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. | [optional] **product_description** | **str** | Brief description of item. | [optional] -**gift_card_currency** | **int** | When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] +**gift_card_currency** | **int** | When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] **shipping_destination_types** | **str** | Destination to where the item will be shipped. Example: Commercial, Residential, Store | [optional] **gift** | **bool** | This field is only used in DM service. Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - true: Orders are assigned only slight additional risk if billing and shipping addresses are different. - false: Orders are assigned higher additional risk if billing and shipping addresses are different. | [optional] **passenger** | [**Ptsv2paymentsOrderInformationPassenger**](Ptsv2paymentsOrderInformationPassenger.md) | | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationShipTo.md b/docs/Ptsv2paymentsOrderInformationShipTo.md index 74d7101e..f943ab15 100644 --- a/docs/Ptsv2paymentsOrderInformationShipTo.md +++ b/docs/Ptsv2paymentsOrderInformationShipTo.md @@ -18,7 +18,7 @@ Name | Type | Description | Notes **building_number** | **str** | Building number in the street address. For example, the building number is 187 in the following address: Rua da Quitanda 187 | [optional] **phone_number** | **str** | Phone number associated with the shipping address. | [optional] **email** | **str** | Email of the recipient. | [optional] -**company** | **str** | Name of the customer's company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**company** | **str** | Name of the customer's company. | [optional] **destination_types** | **str** | Shipping destination of item. Example: Commercial, Residential, Store | [optional] **destination_code** | **int** | Indicates destination chosen for the transaction. Possible values: - 01- Ship to cardholder billing address - 02- Ship to another verified address on file with merchant - 03- Ship to address that is different than billing address - 04- Ship to store (store address should be populated on request) - 05- Digital goods - 06- Travel and event tickets, not shipped - 07- Other | [optional] **method** | **str** | Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription Required for American Express SafeKey (U.S.). | [optional] diff --git a/docs/Ptsv2paymentsPaymentInformation.md b/docs/Ptsv2paymentsPaymentInformation.md index eb8bba2c..b9fcd7bf 100644 --- a/docs/Ptsv2paymentsPaymentInformation.md +++ b/docs/Ptsv2paymentsPaymentInformation.md @@ -18,6 +18,7 @@ Name | Type | Description | Notes **initiation_channel** | **str** | Mastercard-defined code that indicates how the account information was obtained. - `00`: Card - `01`: Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a mobile phone or smartphone - `02`: Key fob - `03`: Watch using a contactless chip or a fixed (non-removable) secure element not controlled by the MNO - `04`: Mobile tag - `05`: Wristband - `06`: Mobile phone case or sleeve - `07`: Mobile phone or smartphone with a fixed (non-removable) secure element controlled by the MNO,for example, code division multiple access (CDMA) - `08`: Removable secure element not controlled by the MNO, for example, memory card personalized forused with a mobile phone or smartphone - `09`: Mobile Phone or smartphone with a fixed (non-removable) secure element not controlled by the MNO - `10`: MNO controlled removable secure element (SIM or UICC) personalized for use with a tablet or e-book - `11`: Tablet or e-book with a fixed (non-removable) secure element controlled by the MNO - `12`: Removable secure element not controlled by the MNO, for example, memory card personalized foruse with a tablet or e-book - `13`: Tablet or e-book with fixed (non-removable) secure element not controlled by the MNO - `14`: Mobile phone or smartphone with a payment application running in a host processor - `15`: Tablet or e-book with a payment application running in a host processor - `16`: Mobile phone or smartphone with a payment application running in the Trusted ExecutionEnvironment (TEE) of a host processor - `17`: Tablet or e-book with a payment application running in the TEE of a host processor - `18`: Watch with a payment application running in the TEE of a host processor - `19`: Watch with a payment application running in a host processor Values from 20–99 exclusively indicate the form factor only without also indicating the storage technology - `20`: Card - `21`: Phone e.g. Mobile Phone - `22`: Tablet/e-reader - `23`: Watch/Wristband e.g. Watch or wristband, including a fitness band, smart strap, disposable band, watch add-on, and security/ID band - `24`: Sticker - `25`: PC - `26`: Device Peripheral e.g. mobile phone case or sleeve - `27`: Tag e.g. key fob or mobile tag - `28`: Jewelry e.g. ring, bracelet, necklace and cuff links - `29`: Fashion Accessory e.g. handbag, bag charm and glasses - `30`: Garment e.g. dress - `31`: Domestic Appliance e.g refrigerator, washing machine - `32`: Vehicle e.g. vehicle, including vehicle attached devices - `33`: Media/Gaming Device e.g. media or gaming device, including a set top box, media player and television 34–99 are reserved for future form factors. Any value in this range may occur within form factor and transaction data without prior notice. This field is supported only for Mastercard on CyberSource through VisaNet. When initiation channel is not provided via this API field, the value is extracted from EMV tag 9F6E for Mastercard transactions. To enable this feature please call support. #### Used by **Authorization** Optional field. | [optional] **sepa** | [**Ptsv2paymentsPaymentInformationSepa**](Ptsv2paymentsPaymentInformationSepa.md) | | [optional] **e_wallet** | [**Ptsv2paymentsPaymentInformationEWallet**](Ptsv2paymentsPaymentInformationEWallet.md) | | [optional] +**payment_account_reference** | [**Ptsv2paymentsPaymentInformationPaymentAccountReference**](Ptsv2paymentsPaymentInformationPaymentAccountReference.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsPaymentInformationPaymentAccountReference.md b/docs/Ptsv2paymentsPaymentInformationPaymentAccountReference.md new file mode 100644 index 00000000..429bb478 --- /dev/null +++ b/docs/Ptsv2paymentsPaymentInformationPaymentAccountReference.md @@ -0,0 +1,10 @@ +# Ptsv2paymentsPaymentInformationPaymentAccountReference + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **str** | A Payment Account Reference number (PAR) is a unique reference value associated with a specific card holder PAN. It identifies the card account, not just a card. PAR is a non-payment identifier that can be associated to PANs and tokens, as defined by EMVCo. PAR allows all participants in the payments chain to have a single, non-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder identification fields, and transmitted across the payments ecosystem to facilitate card holder identification. PAR has a well-defined format (as per the Jan 2016 EMVCo documentation): | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md b/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md index 526fc2fb..9c77566a 100644 --- a/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md +++ b/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md @@ -4,15 +4,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **number** | **str** | Customer's payment network token value. | [optional] -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] **type** | **str** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay - '070': EFTPOS [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] **cryptogram** | **str** | This field contains token information. | [optional] **requestor_id** | **str** | Value that identifies your business and indicates that the cardholder's account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider's database. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. #### PIN debit Optional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. | [optional] **transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | [optional] **assurance_level** | **str** | Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. Returned by PIN debit credit or PIN debit purchase. **Note** Merchants supported for **CyberSource through VisaNet**/**Visa Platform Connect** are advised not to use this field. | [optional] **storage_method** | **str** | Type of technology used in the device to store token data. Possible values: - `001`: Secure Element (SE). Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment credentials, a SE is tested against a set of requirements defined by the payment networks. **Note** This field is supported only for _FDC Compass_. - 002: Host Card Emulation (HCE). Emulation of a smart card by using software to create a virtual and exact representation of the card. Sensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database must meet very stringent security requirements that exceed PCI DSS. **Note** This field is supported only for _FDC Compass_. | [optional] -**security_code** | **str** | Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. For details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**security_code** | **str** | Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. | [optional] **security_code_indicator** | **str** | Indicates whether a CVN code was sent. Possible values: - `0` (default): CVN service not requested. This default value is used when you do not include `securityCode` field in the request. - `1` (default): CVN service requested and supported. This default value is used when you include `securityCode` field in the request. - `2`: CVN on credit card is illegible. - `9`: CVN was not imprinted on credit card. #### FDMS Nashville Required for American Express cards; otherwise, optional. #### TSYS Acquiring Solutions Optional if `pointOfSaleInformation.entryMode=keyed`; otherwise, not used. #### All other processors Optional. | [optional] **assurance_method** | **str** | Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **Visa Platform Connect** | [optional] diff --git a/docs/Ptsv2paymentsPointOfSaleInformation.md b/docs/Ptsv2paymentsPointOfSaleInformation.md index 8d6b293c..eb4fd7c7 100644 --- a/docs/Ptsv2paymentsPointOfSaleInformation.md +++ b/docs/Ptsv2paymentsPointOfSaleInformation.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **terminal_capability** | **int** | POS terminal's capability. Possible values: - `1`: Terminal has a magnetic stripe reader only. - `2`: Terminal has a magnetic stripe reader and manual entry capability. - `3`: Terminal has manual entry capability only. - `4`: Terminal can read chip cards. - `5`: Terminal can read contactless chip cards; cannot use contact to read chip cards. For an EMV transaction, the value of this field must be `4` or `5`. #### PIN debit Required for PIN debit purchase and PIN debit credit request. #### Used by **Authorization** Required for the following processors: - American Express Direct - Chase Paymentech Solutions - Credit Mutuel-CIC - FDC Nashville Global - FDMS Nashville - OmniPay Direct - SIX - Worldpay VAP Optional for the following processors: - CyberSource through VisaNet - GPN - GPX - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions | [optional] **operating_environment** | **str** | Operating environment. Possible values for all card types except Mastercard: - `0`: No terminal used or unknown environment. - `1`: On merchant premises, attended. - `2`: On merchant premises, unattended. Examples: oil, kiosks, self-checkout, mobile telephone, personal digital assistant (PDA). - `3`: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in taxis. - `4`: Off merchant premises, unattended. Examples: vending machines, home computer, mobile telephone, PDA. - `5`: On premises of cardholder, unattended. - `9`: Unknown delivery mode. - `S`: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the internet. - `T`: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier. #### Possible values for Mastercard: - `2`: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for Mastercard transactions on CyberSource through VisaNet. - `4`: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer, mobile telephone, PDA. Cardholder terminal is supported only for Mastercard transactions on CyberSource through VisaNet. This field is supported only for American Express Direct and CyberSource through VisaNet. | [optional] **emv** | [**Ptsv2paymentsPointOfSaleInformationEmv**](Ptsv2paymentsPointOfSaleInformationEmv.md) | | [optional] -**amex_capn_data** | **str** | Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**amex_capn_data** | **str** | Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. | [optional] **track_data** | **str** | Card's track 1 and 2 data. For all processors except FDMS Nashville, this value consists of one of the following: - Track 1 data - Track 2 data - Data for both tracks 1 and 2 For FDMS Nashville, this value consists of one of the following: - Track 1 data - Data for both tracks 1 and 2 Example: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000? #### Used by **Authorization** Required for Chase Paymentech Solutions, Credit Mutuel-CIC, CyberSource through VisaNet, FDC Nashville Global, JCN Gateway, OmniPay Direct, and SIX if `pointOfSaleInformation.entryMode` is equal to one of these values: - `contact` - `contactless` - `msd` - `swiped` Otherwise, this field not used. Required for all other processors if `pointOfSaleInformation.entryMode=swiped`; otherwise, this field is not used. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### PIN debit Track 2 data from the debit card. The sentinels are required. Required field for a PIN debit purchase and a PIN debit credit. | [optional] **store_and_forward_indicator** | **str** | When connectivity is unavailable, the client software that is installed on the POS terminal can store a transaction in its memory and send it for authorization when connectivity is restored. This value is provided by the client software that is installed on the POS terminal. This value is not forwarded to the processor. Instead, the value is forwarded to the reporting functionality. Possible values: - `Y`: Transaction was stored and then forwarded. - `N` (default): Transaction was not stored and then forwarded. For authorizations and credits, this field is supported only on these processors: - American Express Direct - FDC Nashville Global - OmniPay Direct - SIX Optional field. | [optional] **cardholder_verification_method** | **list[str]** | Complete list of cardholder verification methods (CVMs) supported by the terminal. Optional field. Possible values: - `PIN`: For terminals with a PIN Pad - `Signature`: For terminals capable of receiving a signature - `pinOnGlass`: For terminals where PIN is entered on a glass-based capture mechanism **EXAMPLE**: [\"PIN\",\"Signature\"]; [\"pinOnGlass\",\"Signature\"] | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformation.md b/docs/Ptsv2paymentsProcessingInformation.md index 7265f75e..dbcd0db9 100644 --- a/docs/Ptsv2paymentsProcessingInformation.md +++ b/docs/Ptsv2paymentsProcessingInformation.md @@ -12,13 +12,12 @@ Name | Type | Description | Notes **business_application_id** | **str** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. | [optional] **commerce_indicator** | **str** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] **commerce_indicator_label** | **str** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` | [optional] -**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] +**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **reconciliation_id** | **str** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] **link_id** | **str** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] **purchase_level** | **str** | Set this field to 3 to indicate that the request includes Level III data. | [optional] **transaction_timeout** | **int** | The time-out limit in seconds for the transaction. The time-out limit starts when the customer is directed to the merchant URL that is included in the sale service response. The maximum value is 99999 (about 27 hours). When the transaction times out, the payment system changes the status to abandoned. | [optional] **intents_id** | **str** | Set to the value of the requestID field returned in the order service response. | [optional] -**payment_id** | **str** | This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream. | [optional] **report_group** | **str** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] **visa_checkout_id** | **str** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] **industry_data_type** | **str** | Indicates that the transaction includes industry-specific data. Possible Values: - `airline` - `restaurant` - `lodging` - `auto_rental` - `transit` - `healthcare_medical` - `healthcare_transit` - `transit` #### Card Present, Airlines and Auto Rental You must set this field to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to `airline` or is not included in the request, no airline data is sent to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to `restaurant` or is not included in the request, no restaurant data is sent to the processor. You must set this field to `auto_rental` in order for auto rental data to be sent to the processor. For example, if this field is not set to `auto_rental` or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet. | [optional] @@ -40,6 +39,7 @@ Name | Type | Description | Notes **is_return_auth_record_enabled** | **bool** | Flag that indicates the functionality we are having for merchants for which auth is done through Cybersource but settlement is done by themselves. true: functionality is supported. Processor should send raw processor auth response to Merchant. false: functionality is not supported. Default: false | [optional] **network_partner_id** | **str** | Merchant payment gateway ID that is assigned by Mastercard and is provided by the acquirer when a registered merchant payment gateway service provider is involved in the transaction. This field is supported for Visa Platform Connect. | [optional] **payment_type** | **str** | Identifier for the payment type. | [optional] +**enabler_id** | **str** | Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsProcessingInformationLoanOptions.md b/docs/Ptsv2paymentsProcessingInformationLoanOptions.md index 69c23d45..eced32a0 100644 --- a/docs/Ptsv2paymentsProcessingInformationLoanOptions.md +++ b/docs/Ptsv2paymentsProcessingInformationLoanOptions.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **str** | Type of loan based on an agreement between you and the issuer. Examples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME. This field is supported only for these kinds of payments: - BNDES transactions on CyberSource through VisaNet. - Installment payments with Mastercard on CyberSource through VisaNet in Brazil. See \"\"Installment Payments on CyberSource through VisaNet,\"\" in the SCMP/SO guide For BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR2, Position: 27-46, Field: Loan Type For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR4, Position: 5-24,Field: Financing Type | [optional] +**type** | **str** | Type of loan based on an agreement between you and the issuer. Examples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME. This field is supported only for these kinds of payments: - BNDES transactions on CyberSource through VisaNet. - Installment payments with Mastercard on CyberSource through VisaNet in Brazil. For BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR2, Position: 27-46, Field: Loan Type For installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP07 TCR4, Position: 5-24,Field: Financing Type | [optional] **asset_type** | **str** | Indicates whether a loan is for a recoverable item or a non-recoverable item. Possible values: - `N`: non-recoverable item - `R`: recoverable item This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: Record: CP07 TCR2, Position: 26, Field: Asset Indicator | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsProcessingInformationRecurringOptions.md b/docs/Ptsv2paymentsProcessingInformationRecurringOptions.md index 2224fff9..399a9dfe 100644 --- a/docs/Ptsv2paymentsProcessingInformationRecurringOptions.md +++ b/docs/Ptsv2paymentsProcessingInformationRecurringOptions.md @@ -3,8 +3,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**loan_payment** | **bool** | Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment For processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] [default to False] -**first_recurring_payment** | **bool** | Flag that indicates whether this transaction is the first in a series of recurring payments. This field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**. Possible values: - `true` Indicates this is the first payment in a series of recurring payments - `false` (default) Indicates this is not the first payment in a series of recurring payments. For details, see `auth_first_recurring_payment` field description and \"Recurring Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] [default to False] +**loan_payment** | **bool** | Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment | [optional] [default to False] +**first_recurring_payment** | **bool** | Flag that indicates whether this transaction is the first in a series of recurring payments. This field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**. Possible values: - `true` Indicates this is the first payment in a series of recurring payments - `false` (default) Indicates this is not the first payment in a series of recurring payments. | [optional] [default to False] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsRecipientInformation.md b/docs/Ptsv2paymentsRecipientInformation.md index f8e33fe1..9bc14f89 100644 --- a/docs/Ptsv2paymentsRecipientInformation.md +++ b/docs/Ptsv2paymentsRecipientInformation.md @@ -3,11 +3,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**account_id** | **str** | Identifier for the recipient's account. Use the first six digits and last four digits of the recipient's account number. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_account_id` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**last_name** | **str** | Recipient's last name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_lastname` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**middle_name** | **str** | Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_middlename` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**postal_code** | **str** | Partial postal code for the recipient's address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipient_postal_code` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**date_of_birth** | **str** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**account_id** | **str** | Identifier for the recipient's account. Use the first six digits and last four digits of the recipient's account number. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipientInformation.accountId` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) | [optional] +**last_name** | **str** | Recipient's last name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipientInformation.lastName` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) | [optional] +**middle_name** | **str** | Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For details, see the `recipientInformation.middleName` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) | [optional] +**postal_code** | **str** | Partial postal code for the recipient's address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] +**date_of_birth** | **str** | 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] **beneficiary_id** | **str** | Only for e-wallets: ID, username, hash or anything uniquely identifying the ultimate beneficiary. | [optional] **beneficiary_name** | **str** | Only for e-wallets: The ultimate beneficiary's full name. | [optional] **beneficiary_address** | **str** | Only for e-wallets: The ultimate beneficiary's street address (street, zip code, city), excluding the country. Example: \"Main street 1, 12345, Barcelona | [optional] diff --git a/docs/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md b/docs/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md index f663c508..c4bd4245 100644 --- a/docs/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md +++ b/docs/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | Sub-merchant's business name. #### American Express Direct The maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. #### CyberSource through VisaNet With American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. | [optional] -**address1** | **str** | First line of the sub-merchant's street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**locality** | **str** | Sub-merchant's city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**administrative_area** | **str** | Sub-merchant's state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**postal_code** | **str** | Partial postal code for the sub-merchant's address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**country** | **str** | Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. For details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**address1** | **str** | First line of the sub-merchant's street address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**locality** | **str** | Sub-merchant's city. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**administrative_area** | **str** | Sub-merchant's state or province. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**postal_code** | **str** | Partial postal code for the sub-merchant's address. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**country** | **str** | Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. | [optional] **email** | **str** | Sub-merchant's email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] **phone_number** | **str** | Sub-merchant's telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` | [optional] **id** | **str** | The ID you assigned to your sub-merchant. CyberSource through VisaNet: For American Express transaction, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 65-84 - Field: American Express Seller ID For Mastercard transactions, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 117-131 - Field: Sub-Merchant ID FDC Compass: This value must consist of uppercase characters. American Express Direct: String (20) CyberSource through VisaNet with American Express: String (20) CyberSource through VisaNet with Visa,Mastercard and Discover: String (15) FDC Compass: String (20) FDC Nashville Global: String (14) | [optional] diff --git a/docs/Ptsv2paymentsidcapturesInstallmentInformation.md b/docs/Ptsv2paymentsidcapturesInstallmentInformation.md index 0ab1ae87..afadf867 100644 --- a/docs/Ptsv2paymentsidcapturesInstallmentInformation.md +++ b/docs/Ptsv2paymentsidcapturesInstallmentInformation.md @@ -3,31 +3,31 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**amount** | **str** | Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**frequency** | **str** | Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. For details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**plan_type** | **str** | #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. For details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) | [optional] -**sequence** | **int** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] -**total_amount** | **str** | Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. For details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] -**total_count** | **int** | Total number of installments when making payments in installments. For details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. For details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] -**first_installment_date** | **str** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional] +**amount** | **str** | Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. | [optional] +**frequency** | **str** | Frequency of the installment payments. When you do not include this field in a request for a Crediario installment payment, CyberSource sends a space character to the processor. This field is supported only for CyberSource through VisaNet. Possible values: - `B`: Biweekly - `M`: Monthly - `W`: Weekly For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR9 - Position: 41 - Field: Installment Frequency | [optional] +**plan_type** | **str** | #### American Express Direct, Cielo, and CyberSource Latin American Processing Flag that indicates the type of funding for the installment plan associated with the payment. Possible values: - `1`: Merchant-funded installment plan - `2`: Issuer-funded installment plan If you do not include this field in the request, CyberSource uses the value in your CyberSource account. To change the value in your CyberSource account, contact CyberSource Customer Service. #### CyberSource through VisaNet and American Express Defined code that indicates the type of installment plan for this transaction. Contact American Express for: - Information about the kinds of installment plans that American Express provides - Values for this field For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 5-6 - Field: Plan Type * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. #### CyberSource through VisaNet with Visa or Mastercard Flag indicating the type of funding for the installment plan associated with the payment. Possible values: - 1 or 01: Merchant-funded installment plan - 2 or 02: Issuer-funded installment plan - 43: Crediario installment plan—only with Visa in Brazil For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 5-6 - Field: Installment Type For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR5 - Position: 39-40 - Field: Installment Plan Type (Issuer or Merchant) | [optional] +**sequence** | **int** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] +**total_amount** | **str** | Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. | [optional] +**total_count** | **int** | Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] +**first_installment_date** | **str** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional] **first_installment_amount** | **str** | Amount of the first installment payment. The issuer provides this value when the first installment payment is successful. This field is supported for Mastercard installment payments on CyberSource through VisaNet in all countries except Brazil,Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 23-34 - Field: Amount of Each Installment | [optional] -**invoice_data** | **str** | Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification | [optional] -**payment_type** | **str** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional] -**additional_costs** | **str** | Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs | [optional] -**additional_costs_percentage** | **str** | Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs | [optional] -**amount_funded** | **str** | Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded | [optional] -**amount_requested_percentage** | **str** | Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested | [optional] -**annual_financing_cost** | **str** | Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing | [optional] -**annual_interest_rate** | **str** | Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate | [optional] -**expenses** | **str** | Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses | [optional] -**expenses_percentage** | **str** | Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses | [optional] -**fees** | **str** | Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees | [optional] -**fees_percentage** | **str** | Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees | [optional] -**insurance** | **str** | Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance | [optional] -**insurance_percentage** | **str** | Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance | [optional] -**monthly_interest_rate** | **str** | Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate | [optional] -**taxes** | **str** | Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes | [optional] -**taxes_percentage** | **str** | Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes | [optional] +**invoice_data** | **str** | Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification | [optional] +**payment_type** | **str** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional] +**additional_costs** | **str** | Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs | [optional] +**additional_costs_percentage** | **str** | Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs | [optional] +**amount_funded** | **str** | Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded | [optional] +**amount_requested_percentage** | **str** | Amount requested divided by the amount funded. For example: - A value of 90.0 specifies 90%. - A value of 93.7 specifies 93.7%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 60-63 - Field: Percent of Amount Requested | [optional] +**annual_financing_cost** | **str** | Annual cost of financing the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 158-164 - Field: Annual Total Cost of Financing | [optional] +**annual_interest_rate** | **str** | Annual interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 151-157 - Field: Annual Interest Rate | [optional] +**expenses** | **str** | Expenses charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 64-75 - Field: Total Expenses | [optional] +**expenses_percentage** | **str** | Expenses divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 76-79 - Field: Percent of Total Expenses | [optional] +**fees** | **str** | Fees charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 80-91 - Field: Total Fees | [optional] +**fees_percentage** | **str** | Fees divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 92-95 - Field: Percent of Total Fees | [optional] +**insurance** | **str** | Insurance charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 112-123 - Field: Total Insurance | [optional] +**insurance_percentage** | **str** | Insurance costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 124-127 - Field: Percent Of Total Insurance | [optional] +**monthly_interest_rate** | **str** | Monthly interest rate. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 144-150 - Field: Monthly Interest Rate | [optional] +**taxes** | **str** | Taxes collected by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 96-107 - Field: Total Taxes | [optional] +**taxes_percentage** | **str** | Taxes divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 108-111 - Field: Percent of Total Taxes | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsidcapturesMerchantInformation.md b/docs/Ptsv2paymentsidcapturesMerchantInformation.md index 7b670d8a..1693fa55 100644 --- a/docs/Ptsv2paymentsidcapturesMerchantInformation.md +++ b/docs/Ptsv2paymentsidcapturesMerchantInformation.md @@ -4,11 +4,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **merchant_descriptor** | [**Ptsv2paymentsMerchantInformationMerchantDescriptor**](Ptsv2paymentsMerchantInformationMerchantDescriptor.md) | | [optional] -**card_acceptor_reference_number** | **str** | Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**category_code** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] -**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**card_acceptor_reference_number** | **str** | Reference number that facilitates card acceptor/corporation communication and record keeping. | [optional] +**category_code** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] +**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. | [optional] **service_fee_descriptor** | [**Ptsv2paymentsMerchantInformationServiceFeeDescriptor**](Ptsv2paymentsMerchantInformationServiceFeeDescriptor.md) | | [optional] -**tax_id** | **str** | Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**tax_id** | **str** | Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.md b/docs/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.md index 5cb12961..735ccd65 100644 --- a/docs/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.md +++ b/docs/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**purchase_order_number** | **str** | Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the `user_po` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**purchase_order_date** | **str** | Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the `purchaser_order_date` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**purchase_contact_name** | **str** | The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the `authorized_contact_name` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxable** | **bool** | 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] -**vat_invoice_reference_number** | **str** | VAT invoice number associated with the transaction. For processor-specific information, see the `vat_invoice_ref_number` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**commodity_code** | **str** | International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the `summary_commodity_code` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**purchase_order_number** | **str** | Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. | [optional] +**purchase_order_date** | **str** | Date the order was processed. `Format: YYYY-MM-DD`. | [optional] +**purchase_contact_name** | **str** | The name of the individual or the company contacted for company authorized purchases. | [optional] +**taxable** | **bool** | 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. Possible values: - **true** - **false** | [optional] +**vat_invoice_reference_number** | **str** | VAT invoice number associated with the transaction. | [optional] +**commodity_code** | **str** | International description code of the overall order's goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. | [optional] **transaction_advice_addendum** | [**list[Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum]**](Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsidcapturesPointOfSaleInformation.md b/docs/Ptsv2paymentsidcapturesPointOfSaleInformation.md index de4ab466..2aa80c53 100644 --- a/docs/Ptsv2paymentsidcapturesPointOfSaleInformation.md +++ b/docs/Ptsv2paymentsidcapturesPointOfSaleInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **emv** | [**Ptsv2paymentsidcapturesPointOfSaleInformationEmv**](Ptsv2paymentsidcapturesPointOfSaleInformationEmv.md) | | [optional] -**amex_capn_data** | **str** | Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**amex_capn_data** | **str** | Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsidcapturesProcessingInformation.md b/docs/Ptsv2paymentsidcapturesProcessingInformation.md index 78b97c87..fd012f35 100644 --- a/docs/Ptsv2paymentsidcapturesProcessingInformation.md +++ b/docs/Ptsv2paymentsidcapturesProcessingInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] +**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **reconciliation_id** | **str** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] **link_id** | **str** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] **report_group** | **str** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] diff --git a/docs/Ptsv2paymentsidrefundsMerchantInformation.md b/docs/Ptsv2paymentsidrefundsMerchantInformation.md index 3fa5ad13..eed21958 100644 --- a/docs/Ptsv2paymentsidrefundsMerchantInformation.md +++ b/docs/Ptsv2paymentsidrefundsMerchantInformation.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **merchant_descriptor** | [**Ptsv2paymentsMerchantInformationMerchantDescriptor**](Ptsv2paymentsMerchantInformationMerchantDescriptor.md) | | [optional] -**category_code** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] -**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**card_acceptor_reference_number** | **str** | Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the `card_acceptor_ref_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**tax_id** | **str** | Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] +**category_code** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] +**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. | [optional] +**card_acceptor_reference_number** | **str** | Reference number that facilitates card acceptor/corporation communication and record keeping. | [optional] +**tax_id** | **str** | Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsidrefundsOrderInformationLineItems.md b/docs/Ptsv2paymentsidrefundsOrderInformationLineItems.md index 211be63f..e54e651b 100644 --- a/docs/Ptsv2paymentsidrefundsOrderInformationLineItems.md +++ b/docs/Ptsv2paymentsidrefundsOrderInformationLineItems.md @@ -3,18 +3,18 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] **product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] **product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] **quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] **unit_of_measure** | **str** | Unit of measure, or unit of measure code, for the item. | [optional] **total_amount** | **str** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional] **tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] -**tax_rate** | **str** | Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **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] +**tax_rate** | **str** | Tax rate applied to the item. **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] **tax_applied_after_discount** | **str** | Flag to indicate how you handle discount at the line item level. - 0: no line level discount provided - 1: tax was calculated on the post-discount line item total - 2: tax was calculated on the pre-discount line item total `Note` Visa will inset 0 (zero) if an invalid value is included in this field. This field relates to the value in the _lineItems[].discountAmount_ field. | [optional] **tax_status_indicator** | **str** | Flag to indicate whether tax is exempted or not included. - 0: tax not included - 1: tax included - 2: transaction is not subject to tax | [optional] -**tax_type_code** | **str** | Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` | [optional] +**tax_type_code** | **str** | Type of tax being applied to the item. #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator` | [optional] **amount_includes_tax** | **bool** | Flag that indicates whether the tax amount is included in the Line Item Total. Possible values: - **true** - **false** | [optional] **type_of_supply** | **str** | Flag to indicate whether the purchase is categorized as goods or services. Possible values: - 00: goods - 01: services | [optional] **commodity_code** | **str** | Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes. | [optional] diff --git a/docs/Ptsv2paymentsidrefundsPaymentInformation.md b/docs/Ptsv2paymentsidrefundsPaymentInformation.md index 887dc63e..04dde0ab 100644 --- a/docs/Ptsv2paymentsidrefundsPaymentInformation.md +++ b/docs/Ptsv2paymentsidrefundsPaymentInformation.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **legacy_token** | [**Ptsv2paymentsPaymentInformationLegacyToken**](Ptsv2paymentsPaymentInformationLegacyToken.md) | | [optional] **payment_type** | [**Ptsv2paymentsidrefundsPaymentInformationPaymentType**](Ptsv2paymentsidrefundsPaymentInformationPaymentType.md) | | [optional] **e_wallet** | [**Ptsv2paymentsidrefundsPaymentInformationEWallet**](Ptsv2paymentsidrefundsPaymentInformationEWallet.md) | | [optional] +**payment_account_reference** | [**Ptsv2paymentsPaymentInformationPaymentAccountReference**](Ptsv2paymentsPaymentInformationPaymentAccountReference.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsidrefundsProcessingInformation.md b/docs/Ptsv2paymentsidrefundsProcessingInformation.md index 91949408..12e2d745 100644 --- a/docs/Ptsv2paymentsidrefundsProcessingInformation.md +++ b/docs/Ptsv2paymentsidrefundsProcessingInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **action_list** | **list[str]** | Array of actions (one or more) to be included in the payment to invoke bundled services along with payment status. Possible values are one or more of follows: - `AP_REFUND`: Use this when Alternative Payment Refund service is requested. | [optional] -**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] +**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **reconciliation_id** | **str** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] **link_id** | **str** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] **report_group** | **str** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] diff --git a/docs/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.md b/docs/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.md index cb3e30fd..3de2780d 100644 --- a/docs/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.md +++ b/docs/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**loan_payment** | **bool** | Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment For processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | [optional] [default to False] +**loan_payment** | **bool** | Flag that indicates whether this is a payment towards an existing contractual loan. Possible values: - `true`: Loan payment - `false`: (default) Not a loan payment | [optional] [default to False] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsidreversalsOrderInformationLineItems.md b/docs/Ptsv2paymentsidreversalsOrderInformationLineItems.md index d5d8ee0b..92cd9e03 100644 --- a/docs/Ptsv2paymentsidreversalsOrderInformationLineItems.md +++ b/docs/Ptsv2paymentsidreversalsOrderInformationLineItems.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2paymentsidreversalsProcessingInformation.md b/docs/Ptsv2paymentsidreversalsProcessingInformation.md index 211e0c43..2c116fb7 100644 --- a/docs/Ptsv2paymentsidreversalsProcessingInformation.md +++ b/docs/Ptsv2paymentsidreversalsProcessingInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] +**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **reconciliation_id** | **str** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] **link_id** | **str** | Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request. This value is used for: - Partial authorizations - Split shipments | [optional] **report_group** | **str** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. | [optional] diff --git a/docs/Ptsv2payoutsMerchantInformation.md b/docs/Ptsv2payoutsMerchantInformation.md index 1570b0ea..7b040f7d 100644 --- a/docs/Ptsv2payoutsMerchantInformation.md +++ b/docs/Ptsv2payoutsMerchantInformation.md @@ -3,9 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**category_code** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] +**category_code** | **int** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] **submit_local_date_time** | **str** | Time that the transaction was submitted in local time. The time is in hhmmss format. | [optional] -**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. | [optional] **merchant_descriptor** | [**Ptsv2payoutsMerchantInformationMerchantDescriptor**](Ptsv2payoutsMerchantInformationMerchantDescriptor.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2payoutsMerchantInformationMerchantDescriptor.md b/docs/Ptsv2payoutsMerchantInformationMerchantDescriptor.md index 56c4d44e..88af243d 100644 --- a/docs/Ptsv2payoutsMerchantInformationMerchantDescriptor.md +++ b/docs/Ptsv2payoutsMerchantInformationMerchantDescriptor.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes **country** | **str** | Merchant's country. #### PIN debit Country code for your business location. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) This value might be displayed on the cardholder's statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** If your business is located in the U.S. or Canada and you include this field in a request, you must also include `merchantInformation.merchantDescriptor.administrativeArea`. Optional field for PIN debit credit or PIN debit purchase. | [optional] **administrative_area** | **str** | The state where the merchant is located. #### PIN debit State code or region code for your business. Use the 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) This value might be displayed on the cardholder's statement. When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. Optional field for PIN debit credit or PIN debit purchase. | [optional] **postal_code** | **str** | Merchant's postal code. #### PIN debit Postal code for your business location. This value might be displayed on the cardholder's statement. If your business is domiciled in the U.S., you can use a 5-digit or 9-digit postal code. A 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example: `12345-6789` If your business is domiciled in Canada, you can use a 6-digit or 9-digit postal code. A 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example: `A1B 2C3` When you do not include this value in your PIN debit request, the merchant name from your account is used. **Important** This value must consist of English characters. **Note** This field is supported only for businesses located in the U.S. or Canada. **Important** Mastercard requires a postal code for any country that uses postal codes. You can provide the postal code in your account or you can include this field in your request. Optional field for PIN debit credit or PIN debit purchase. | [optional] -**contact** | **str** | For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) | [optional] -**address1** | **str** | First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**contact** | **str** | Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) | [optional] +**address1** | **str** | First line of merchant's address. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Ptsv2payoutsProcessingInformation.md b/docs/Ptsv2payoutsProcessingInformation.md index 86a2bbbf..d2e1c060 100644 --- a/docs/Ptsv2payoutsProcessingInformation.md +++ b/docs/Ptsv2payoutsProcessingInformation.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **business_application_id** | **str** | Payouts transaction type. Applicable Processors: FDC Compass, Paymentech, CtV Possible values: **Credit Card Bill Payment** - **CP**: credit card bill payment **Funds Disbursement** - **FD**: funds disbursement - **GD**: government disbursement - **MD**: merchant disbursement **Money Transfer** - **AA**: account to account. Sender and receiver are same person. - **PP**: person to person. Sender and receiver are different. **Prepaid Load** - **TU**: top up | [optional] -**network_routing_order** | **str** | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. For details, see the `network_order` field description in [BIN Lookup Service Using the SCMP API.](http://apps.cybersource.com/library/documentation/BIN_Lookup/BIN_Lookup_SCMP_API/html/) | [optional] -**commerce_indicator** | **str** | Type of transaction. Value for an OCT transaction: - `internet` For details, see the `e_commerce_indicator` field description in [Payouts Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SCMP/html/) | [optional] +**network_routing_order** | **str** | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. | [optional] +**commerce_indicator** | **str** | Type of transaction. Value for an OCT transaction: - `internet` | [optional] **reconciliation_id** | **str** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] **payouts_options** | [**Ptsv2payoutsProcessingInformationPayoutsOptions**](Ptsv2payoutsProcessingInformationPayoutsOptions.md) | | [optional] **transaction_reason** | **str** | Transaction reason code. | [optional] diff --git a/docs/Ptsv2voidsProcessingInformation.md b/docs/Ptsv2voidsProcessingInformation.md index 16515a41..99a6be3b 100644 --- a/docs/Ptsv2voidsProcessingInformation.md +++ b/docs/Ptsv2voidsProcessingInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payment_id** | **str** | This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream. | [optional] +**payment_id** | **object** | This field is to accept the id of credit/capture in the body of the requests so the type of void can be identified and processed correctly. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md b/docs/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md index 99099363..5a2d1bff 100644 --- a/docs/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md +++ b/docs/RiskV1AuthenticationResultsPost201ResponseConsumerAuthenticationInformation.md @@ -21,7 +21,7 @@ Name | Type | Description | Notes **eci_raw** | **str** | ECI value that can be returned for Visa, Mastercard, American Express, JCB, Diners Club, and Discover. The field is absent when authentication fails. If your payment processor is Streamline, you must pass the value of this field instead of the value of `eci` or `ucafCollectionIndicator`. This field can contain one of these values: - `01`: Authentication attempted (Mastercard) - `02`: Successful authentication (Mastercard) - `05`: Successful authentication (Visa, American Express, JCB, Diners Club, and Discover) - `06`: Authentication attempted (Visa, American Express, JCB, Diners Club, and Discover) | [optional] **pares_status** | **str** | 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] **sdk_transaction_id** | **str** | SDK unique transaction identifier that is generated on each new transaction. | [optional] -**specification_version** | **str** | This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0. | [optional] +**specification_version** | **str** | This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 | [optional] **three_ds_server_transaction_id** | **str** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] **ucaf_authentication_data** | **str** | 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] **ucaf_collection_indicator** | **str** | 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] diff --git a/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md b/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md index f0cbae93..229470d5 100644 --- a/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md +++ b/docs/RiskV1DecisionsPost201ResponseConsumerAuthenticationInformation.md @@ -34,7 +34,7 @@ Name | Type | Description | Notes **proxy_pan** | **str** | Encrypted version of the card number used in the payer authentication request message. | [optional] **sdk_transaction_id** | **str** | SDK unique transaction identifier that is generated on each new transaction. | [optional] **signed_pares_status_reason** | **str** | Provides additional information as to why the PAResStatus has a specific value. | [optional] -**specification_version** | **str** | This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0. | [optional] +**specification_version** | **str** | This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0 | [optional] **step_up_url** | **str** | The fully qualified URL that the merchant uses to post a form to the cardholder in order to complete the Consumer Authentication transaction for the Cardinal Cruise API integration. | [optional] **three_ds_server_transaction_id** | **str** | Unique transaction identifier assigned by the 3DS Server to identify a single transaction. | [optional] **ucaf_authentication_data** | **str** | 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] diff --git a/docs/Riskv1addressverificationsOrderInformationLineItems.md b/docs/Riskv1addressverificationsOrderInformationLineItems.md index 10e101f4..ea8a5b21 100644 --- a/docs/Riskv1addressverificationsOrderInformationLineItems.md +++ b/docs/Riskv1addressverificationsOrderInformationLineItems.md @@ -3,12 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | **quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] **product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] **product_risk** | **str** | Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. | [optional] **product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md b/docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md index 4262e34e..3729ce42 100644 --- a/docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md +++ b/docs/Riskv1authenticationresultsPaymentInformationTokenizedCard.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | [optional] **type** | **str** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay - '070': EFTPOS [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] **number** | **str** | Customer's payment network token value. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Riskv1authenticationsOrderInformationLineItems.md b/docs/Riskv1authenticationsOrderInformationLineItems.md index 3635d104..cfc377dd 100644 --- a/docs/Riskv1authenticationsOrderInformationLineItems.md +++ b/docs/Riskv1authenticationsOrderInformationLineItems.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_amount** | **str** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | **quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**gift_card_currency** | **int** | When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] +**gift_card_currency** | **int** | When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] **product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] **product_description** | **str** | Brief description of item. | [optional] **product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] diff --git a/docs/Riskv1authenticationsPaymentInformationTokenizedCard.md b/docs/Riskv1authenticationsPaymentInformationTokenizedCard.md index 3ea4ce67..eec1ad4a 100644 --- a/docs/Riskv1authenticationsPaymentInformationTokenizedCard.md +++ b/docs/Riskv1authenticationsPaymentInformationTokenizedCard.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | **type** | **str** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay - '070': EFTPOS [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | **cryptogram** | **str** | This field contains token information. | -**security_code** | **str** | Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. For details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) | +**security_code** | **str** | Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. | **number** | **str** | Customer's payment network token value. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md b/docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md index 3fbdfeb0..f28d2a7f 100644 --- a/docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md +++ b/docs/Riskv1authenticationsetupsPaymentInformationTokenizedCard.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | **type** | **str** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay - '070': EFTPOS [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | **number** | **str** | Customer's payment network token value. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Riskv1authenticationsetupsProcessingInformation.md b/docs/Riskv1authenticationsetupsProcessingInformation.md index 3fc61333..20c84a1a 100644 --- a/docs/Riskv1authenticationsetupsProcessingInformation.md +++ b/docs/Riskv1authenticationsetupsProcessingInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] +**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **visa_checkout_id** | **str** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Riskv1decisionsOrderInformationAmountDetails.md b/docs/Riskv1decisionsOrderInformationAmountDetails.md index 3b8823b3..5e24ad10 100644 --- a/docs/Riskv1decisionsOrderInformationAmountDetails.md +++ b/docs/Riskv1decisionsOrderInformationAmountDetails.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **str** | 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. | -**total_amount** | **str** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. | [optional] +**total_amount** | **str** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. 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. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [REST API Fields Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html) #### DCC for First Data Not used. For details, see [REST API Field Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Riskv1decisionsOrderInformationLineItems.md b/docs/Riskv1decisionsOrderInformationLineItems.md index 5d34a6e4..5aacf8fa 100644 --- a/docs/Riskv1decisionsOrderInformationLineItems.md +++ b/docs/Riskv1decisionsOrderInformationLineItems.md @@ -4,14 +4,14 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **total_amount** | **str** | Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123 | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] **quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**gift_card_currency** | **int** | When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf) For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] +**gift_card_currency** | **int** | When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the currency used for the gift card purchase. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) | [optional] **product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] **product_risk** | **str** | Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. | [optional] **product_description** | **str** | Brief description of item. | [optional] **product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] **gift** | **bool** | This field is only used in DM service. Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - true: Orders are assigned only slight additional risk if billing and shipping addresses are different. - false: Orders are assigned higher additional risk if billing and shipping addresses are different. | [optional] **distributor_product_sku** | **str** | Product's identifier code. This field is inserted into the outgoing message without being parsed or formatted. This field is included as Distributor product SKU (Offer) in the list of API fields with which you can create custom rules. | [optional] **passenger** | [**Ptsv2paymentsOrderInformationPassenger**](Ptsv2paymentsOrderInformationPassenger.md) | | [optional] diff --git a/docs/Riskv1decisionsPaymentInformationTokenizedCard.md b/docs/Riskv1decisionsPaymentInformationTokenizedCard.md index 4c1fd7fd..670697b8 100644 --- a/docs/Riskv1decisionsPaymentInformationTokenizedCard.md +++ b/docs/Riskv1decisionsPaymentInformationTokenizedCard.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes **transaction_type** | **str** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - `2`: Near-field communication (NFC) transaction. The customer's mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - `1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. **NOTE** No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token. | [optional] **type** | **str** | Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay - '070': EFTPOS [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International | [optional] **number** | **str** | Customer's payment network token value. | [optional] -**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expiration_month** | **str** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] +**expiration_year** | **str** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md b/docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md index 668a2595..4e58f6df 100644 --- a/docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md +++ b/docs/Riskv1exportcomplianceinquiriesOrderInformationLineItems.md @@ -3,14 +3,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | **allowed_export_countries** | **list[str]** | | [optional] **restricted_export_countries** | **list[str]** | | [optional] **quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] **product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] **product_risk** | **str** | Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. | [optional] **product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Riskv1liststypeentriesOrderInformationLineItems.md b/docs/Riskv1liststypeentriesOrderInformationLineItems.md index 96fbdc98..755d5de8 100644 --- a/docs/Riskv1liststypeentriesOrderInformationLineItems.md +++ b/docs/Riskv1liststypeentriesOrderInformationLineItems.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md b/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md index 686149e9..02937196 100644 --- a/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md +++ b/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **number** | **str** | Account number. When processing encoded account numbers, use this field for the encoded account number. | [optional] -**routing_number** | **str** | Bank routing number. This is also called the transit number. For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**routing_number** | **str** | Bank routing number. This is also called the transit number. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TmsPaymentInstrumentProcessingInfo.md b/docs/TmsPaymentInstrumentProcessingInfo.md index 9a7e42ab..d13a0d2c 100644 --- a/docs/TmsPaymentInstrumentProcessingInfo.md +++ b/docs/TmsPaymentInstrumentProcessingInfo.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**bill_payment_program_enabled** | **bool** | Flag that indicates that this is a payment for a bill or for an existing contractual loan. For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) Possible Values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. | [optional] +**bill_payment_program_enabled** | **bool** | Flag that indicates that this is a payment for a bill or for an existing contractual loan. Possible Values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. | [optional] **bank_transfer_options** | [**TmsPaymentInstrumentProcessingInfoBankTransferOptions**](TmsPaymentInstrumentProcessingInfoBankTransferOptions.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md b/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md index 7f940132..dbf33e88 100644 --- a/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md +++ b/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**sec_code** | **str** | Specifies the authorization method for the transaction. #### TeleCheck Possible Values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional] +**sec_code** | **str** | Specifies the authorization method for the transaction. #### TeleCheck Possible Values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md index 589c7a99..d72df720 100644 --- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md +++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **company_tax_id** | **str** | Company's tax identifier. This is only used for eCheck service. | [optional] -**currency** | **str** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) 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. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). | [optional] +**currency** | **str** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) 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. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). | [optional] **date_of_birth** | **date** | Date of birth of the customer. Format: YYYY-MM-DD | [optional] **personal_identification** | [**list[Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification]**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md) | | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md b/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md index 3c904475..e7fa1f8c 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes **product_code** | **str** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. | [optional] **product_name** | **str** | For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] **product_sku** | **str** | Identification code for the product. For Payment and Capture APIs, this field is required when above `productCode` is not **default** or one of the values related to shipping and/or handling. | [optional] -**tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. - 1st line item has `amount=10.00`, `quantity=1`, and `taxAmount=0.80` - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60` 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. For details, see `tax_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) | [optional] +**tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. - 1st line item has `amount=10.00`, `quantity=1`, and `taxAmount=0.80` - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60` 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. | [optional] **quantity** | **int** | For a payment or capture, this field is required when _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] -**unit_price** | **str** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**unit_price** | **str** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. | [optional] **fulfillment_type** | **str** | The description for this field is not available. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md b/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md index 97383d61..1471585b 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **locality** | **str** | City of the shipping address. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] **administrative_area** | **str** | 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] **postal_code** | **str** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. 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 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] -**company** | **str** | Name of the customer's company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**company** | **str** | Name of the customer's company. | [optional] **country** | **str** | Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present. | [optional] **phone_number** | **str** | Phone number associated with the shipping address. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md index 407de5ef..8d5f4696 100644 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. Valid values: - **customer** - **merchant** | [optional] -**credential_stored_on_file** | **str** | Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `N` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] +**credential_stored_on_file** | **str** | Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions. Valid values: - `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `N` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] **stored_credential_used** | **str** | Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file. Possible values: - **Y** means the merchant-initiated transaction came from a card that was already stored on file. - **N** means the merchant-initiated transaction came from a card that was not stored on file. | [optional] **merchant_initiated_transaction** | [**MerchantInitiatedTransactionObject**](MerchantInitiatedTransactionObject.md) | | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseProcessorInformation.md b/docs/TssV2TransactionsGet200ResponseProcessorInformation.md index dbe45465..08ade711 100644 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformation.md +++ b/docs/TssV2TransactionsGet200ResponseProcessorInformation.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **processor** | [**TssV2TransactionsGet200ResponseProcessorInformationProcessor**](TssV2TransactionsGet200ResponseProcessorInformationProcessor.md) | | [optional] **multi_processor_routing** | [**list[TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting]**](TssV2TransactionsGet200ResponseProcessorInformationMultiProcessorRouting.md) | An array of object that contains the list of acquirer response codes & reasons if a transaction is routed to multiple acquirers. | [optional] -**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] +**transaction_id** | **str** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. **Example** For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] **network_transaction_id** | **str** | Same value as `processorInformation.transactionId` | [optional] **retrieval_reference_number** | **str** | #### Ingenico ePayments Unique number that CyberSource generates to identify the transaction. You can use this value to identify transactions in the Ingenico ePayments Collections Report, which provides settlement information. Contact customer support for information about the report. ### CyberSource through VisaNet Retrieval request number. | [optional] **response_id** | **str** | Response ID sent from the processor. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md index 60fd6906..70dba84f 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] +**payment_solution** | **str** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional] **business_application_id** | **str** | Payouts transaction type. Required for OCT transactions. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. **Note** When the request includes this field, this value overrides the information in your CyberSource account. | [optional] **commerce_indicator** | **str** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as \"moto\" | [optional] **commerce_indicator_label** | **str** | Type of transaction. Some payment card companies use this information when determining discount rates. #### Used by **Authorization** Required payer authentication transactions; otherwise, optional. **Credit** Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor. #### Ingenico ePayments When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value #### Card Present You must set this field to `retail`. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as `moto` | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md index da43c4c1..64272039 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **true_ipaddress** | **str** | Customer's true IP address detected by the application. For details, see the `true_ipaddress` field description in _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). | [optional] -**hash** | **str** | The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field. NOTE: For details about the value of this field, see the `decision_provider_#_field_#_value` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). For more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). | [optional] +**hash** | **str** | The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field. For more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link). | [optional] **smart_id** | **str** | The device identifier generated from attributes collected during profiling. Returned by a 3rd party when you use device fingerprinting. For details, see the `device_fingerprint_smart_id` field description in [CyberSource Decision Manager Device Fingerprinting Guide.](https://www.cybersource.com/developers/documentation/fraud_management) | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UnifiedCheckoutCaptureContextApi.md b/docs/UnifiedCheckoutCaptureContextApi.md index 0ad9b7af..5a95a478 100644 --- a/docs/UnifiedCheckoutCaptureContextApi.md +++ b/docs/UnifiedCheckoutCaptureContextApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description Generate Unified Checkout Capture Context -Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). For more information about Click to Pay drop in UI, see the [Click to Pay Drop-in UI Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/click-to-pay/developer/all/rest/click-to-pay/ctp-intro.html). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page +Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions. Click to Pay Drop-in UI is built on the Unified Checkout platform. For more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). Generate Unified Checkout Capture Context Generate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page ### Example ```python diff --git a/docs/Vasv2taxMerchantInformation.md b/docs/Vasv2taxMerchantInformation.md index 3f461a4e..20fd7b26 100644 --- a/docs/Vasv2taxMerchantInformation.md +++ b/docs/Vasv2taxMerchantInformation.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] +**vat_registration_number** | **str** | Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/Vasv2taxOrderInformationLineItems.md b/docs/Vasv2taxOrderInformationLineItems.md index 13bc4ad6..3dae99de 100644 --- a/docs/Vasv2taxOrderInformationLineItems.md +++ b/docs/Vasv2taxOrderInformationLineItems.md @@ -4,10 +4,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **product_sku** | **str** | Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling. | [optional] -**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] +**product_code** | **str** | Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. The Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields]. | [optional] **quantity** | **int** | Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] **product_name** | **str** | For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. | [optional] -**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] +**unit_price** | **str** | Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations 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. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15) | [optional] **tax_amount** | **str** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine | [optional] **order_acceptance** | [**Vasv2taxOrderInformationOrderAcceptance**](Vasv2taxOrderInformationOrderAcceptance.md) | | [optional] **order_origin** | [**Vasv2taxOrderInformationOrderOrigin**](Vasv2taxOrderInformationOrderOrigin.md) | | [optional] @@ -16,7 +16,7 @@ Name | Type | Description | Notes **ship_from_locality** | **str** | City where the product is shipped from. This field is used only when the `orderInformation.shipTo.administrativeArea` and `orderInformation.shipTo.country` fields are present. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] **ship_from_postal_code** | **str** | Postal code where the product is shipped from. #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing. Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. | [optional] **buyer_vat_registration_number** | **str** | Buyer's VAT registration number. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] -**seller_vat_registration_number** | **str** | VAT seller registration number. For details, see \"International Taxes and Value-Added Tax (VAT)\" in [Tax Calculation Service Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Tax_SCMP_API/html/). **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] +**seller_vat_registration_number** | **str** | VAT seller registration number. **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object. #### Tax Calculation Optional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes. | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json index 4b160e7d..74cf88ba 100644 --- a/generator/cybersource-rest-spec.json +++ b/generator/cybersource-rest-spec.json @@ -306,7 +306,7 @@ }, { "name": "BIN_Lookup", - "description": "BIN Lookup Service provides clients with a card network agnostic solution in obtaining Bank Identification Number (BIN) attributes for payment card credentials, empowering our clients to optimize authorizations and routing, reduce fraud, comply with local and industry regulations and improve payment experience as well as acceptance during the checkout.\n\nThe service uses multiple card network BIN sources in the background, providing global and regional coverage when identifying BIN attributes such as: card brand (e.g. Visa, Mastercard, American Express, Discover),card network, card type (e.g. Credit, Debit, Prepaid), card platform (e.g. consumer, Business,\u2026), card product (e.g. Visa gold), credential type (PAN or Network Token), account prefix, issuer name, issuer country.\n\nThe service is flexible and gives your business a choice of input: you can obtain up to date results in real time from this API by sending either cards primary account numbers (PANs), network tokens from Visa (VTS), Mastercard (MDES), or Discover as well as by sending Token Management Service (TMS) tokens.\n" + "description": "The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources.\nThis service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses \nwith a flexible choice of inputs such as primary account number (PAN), network token from major networks which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS).\nCurrently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant.\n" }, { "name": "Transaction_Details", @@ -500,7 +500,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "reconciliationId": { "type": "string", @@ -527,11 +527,6 @@ "maxLength": 26, "description": "Set to the value of the requestID field returned in the order service response." }, - "paymentId": { - "type": "string", - "maxLength": 28, - "description": "This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream." - }, "reportGroup": { "type": "string", "maxLength": 25, @@ -715,12 +710,12 @@ "properties": { "loanPayment": { "type": "boolean", - "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\n\nFor processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n", + "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\n", "default": false }, "firstRecurringPayment": { "type": "boolean", - "description": "Flag that indicates whether this transaction is the first in a series of recurring payments.\n\nThis field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**.\n\nPossible values:\n - `true` Indicates this is the first payment in a series of recurring payments\n - `false` (default) Indicates this is not the first payment in a series of recurring payments.\n\nFor details, see `auth_first_recurring_payment` field description and \"Recurring Payments\" in\n[Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n", + "description": "Flag that indicates whether this transaction is the first in a series of recurring payments.\n\nThis field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**.\n\nPossible values:\n - `true` Indicates this is the first payment in a series of recurring payments\n - `false` (default) Indicates this is not the first payment in a series of recurring payments.\n", "default": false } } @@ -820,7 +815,7 @@ "type": { "type": "string", "maxLength": 20, - "description": "Type of loan based on an agreement between you and the issuer.\nExamples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME.\nThis field is supported only for these kinds of payments:\n- BNDES transactions on CyberSource through VisaNet.\n- Installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nSee \"\"Installment Payments on CyberSource through VisaNet,\"\" in the SCMP/SO guide\n\nFor BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR2, Position: 27-46, Field: Loan Type\n\nFor installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR4, Position: 5-24,Field: Financing Type\n" + "description": "Type of loan based on an agreement between you and the issuer.\nExamples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME.\nThis field is supported only for these kinds of payments:\n- BNDES transactions on CyberSource through VisaNet.\n- Installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nFor BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR2, Position: 27-46, Field: Loan Type\n\nFor installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR4, Position: 5-24,Field: Financing Type\n" }, "assetType": { "type": "string", @@ -950,6 +945,11 @@ "type": "string", "maxLength": 3, "description": "Identifier for the payment type.\n" + }, + "enablerId": { + "type": "string", + "maxLength": 15, + "description": "Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers.\n" } } }, @@ -959,7 +959,7 @@ "discretionaryData": { "type": "string", "maxLength": 255, - "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n" } } }, @@ -1056,12 +1056,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "type": { "type": "string", @@ -1095,7 +1095,7 @@ "securityCode": { "type": "string", "maxLength": 4, - "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n\nFor details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n" }, "securityCodeIndicator": { "type": "string", @@ -1352,6 +1352,16 @@ "description": "Payment method for the unit purchase.\nPossible values:\n- `UNRESTRICTED (default)\u2014this value\nis only available if configured by PayPal\nfor the merchant.`\n- `INSTANT`\n" } } + }, + "paymentAccountReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 32, + "description": "A Payment Account Reference number (PAR) is a unique reference value associated with a specific card holder PAN.\nIt identifies the card account, not just a card. PAR is a non-payment identifier that can be associated\nto PANs and tokens, as defined by EMVCo. PAR allows all participants in the payments chain to have a single,\nnon-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder\nidentification fields, and transmitted across the payments ecosystem to facilitate card holder identification.\nPAR has a well-defined format (as per the Jan 2016 EMVCo documentation):\n" + } + } } } }, @@ -1495,7 +1505,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -1505,26 +1515,26 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" }, "code": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" }, "applied": { "type": "boolean", - "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n" }, "exemptionCode": { "type": "string", "maxLength": 1, - "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n" } } } @@ -1605,7 +1615,7 @@ "taxAmount": { "type": "string", "maxLength": 10, - "description": "Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation. \n" + "description": "Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation.\n" }, "insuranceAmount": { "type": "string", @@ -1618,6 +1628,11 @@ "description": "Amount being charged as gift wrap fee.\n \n" } } + }, + "anticipatedAmount": { + "type": "string", + "maxLength": 15, + "description": "This API Field contains the anticipated amount details. This supports use cases where the Merchant does not wish to have funds held against the account, but needs to confirm an amount prior to authorization, such as for a trial subscription, reservation service, or loyalty program. In an account verification, the anticipated amount is used to confirm the account has availability to accept purchases.\n" } } }, @@ -1860,7 +1875,7 @@ "company": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n" }, "destinationTypes": { "type": "string", @@ -1887,7 +1902,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" }, "productName": { "type": "string", @@ -1909,7 +1924,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "unitOfMeasure": { "type": "string", @@ -1929,7 +1944,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "taxAppliedAfterDiscount": { "type": "string", @@ -1944,7 +1959,7 @@ "taxTypeCode": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "amountIncludesTax": { "type": "boolean", @@ -1986,7 +2001,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -1996,26 +2011,26 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" }, "code": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" }, "applied": { "type": "boolean", - "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n" }, "exemptionCode": { "type": "string", "maxLength": 1, - "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n" } } } @@ -2027,22 +2042,22 @@ "weight": { "type": "string", "maxLength": 9, - "description": "Weight of the item.\n\nFor details, see `weight_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Weight of the item.\n" }, "weightIdentifier": { "type": "string", "maxLength": 1, - "description": "Type of weight.\n\nPossible values:\n- B: Billed weight\n- N: Actual net weight\n\nFor details, see `weight_identifier` offer-level field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Type of weight.\n\nPossible values:\n- B: Billed weight\n- N: Actual net weight\n" }, "weightUnit": { "type": "string", "maxLength": 2, - "description": "Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC).\n\nFor details, see `weight_unit_measurement` offer-level field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC).\n" }, "referenceDataCode": { "type": "string", "maxLength": 150, - "description": "Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field.\n\nPossible values:\n- AN: Client-defined asset code\n- MG: Manufacturer's part number\n- PO: Purchase order number\n- SK: Supplier stock keeping unit number\n- UP: Universal product code\n- VC: Supplier catalog number\n- VP: Vendor part number\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n\nFor details, see `reference_data_#_code` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field.\n\nPossible values:\n- AN: Client-defined asset code\n- MG: Manufacturer's part number\n- PO: Purchase order number\n- SK: Supplier stock keeping unit number\n- UP: Universal product code\n- VC: Supplier catalog number\n- VP: Vendor part number\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" }, "referenceDataNumber": { "type": "string", @@ -2061,7 +2076,7 @@ "giftCardCurrency": { "type": "integer", "maxLength": 3, - "description": "When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the\ncurrency used for the gift card purchase.\n\nFor details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf)\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n" + "description": "When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the\ncurrency used for the gift card purchase.\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n" }, "shippingDestinationTypes": { "type": "string", @@ -2122,14 +2137,14 @@ "type": "array", "items": { "type": "string", - "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n" + "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n" } }, "restrictedExportCountries": { "type": "array", "items": { "type": "string", - "description": "Comma-separated list of ISO country codes for countries to which the product cannot be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\n**Note** If the export field is also present, the content of the `restrictedExportCountries`\nfield overrides the content of export.\n" + "description": "Comma-separated list of ISO country codes for countries to which the product cannot be exported.\n\n**Note** If the export field is also present, the content of the `restrictedExportCountries`\nfield overrides the content of export.\n" } } } @@ -2153,31 +2168,31 @@ "purchaseOrderNumber": { "type": "string", "maxLength": 25, - "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the `user_po` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n" }, "purchaseOrderDate": { "type": "string", "maxLength": 10, - "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the `purchaser_order_date` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n" }, "purchaseContactName": { "type": "string", "maxLength": 36, - "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the `authorized_contact_name` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "The name of the individual or the company contacted for company authorized purchases.\n" }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "vatInvoiceReferenceNumber": { "type": "string", "maxLength": 15, - "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the `vat_invoice_ref_number` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "VAT invoice number associated with the transaction.\n" }, "commodityCode": { "type": "string", "maxLength": 4, - "description": "International description code of the overall order's goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the `summary_commodity_code` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "International description code of the overall order's goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n" }, "merchandiseCode": { "type": "integer", @@ -2199,7 +2214,7 @@ "referenceDataCode": { "type": "string", "maxLength": 3, - "description": "Code that identifies the value of the `referenceDataNumber` field.\n\nFor the possible values, see \"Reference Data Codes\" in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/).\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" + "description": "Code that identifies the value of the `referenceDataNumber` field.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" }, "referenceDataNumber": { "type": "string", @@ -2370,27 +2385,27 @@ "accountId": { "type": "string", "maxLength": 10, - "description": "Identifier for the recipient's account. Use the first six digits and last four digits of the recipient's account\nnumber. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in\nany way before sending it to the processor. If the field is not required for the transaction, CyberSource does\nnot forward it to the processor.\n\nFor details, see the `recipient_account_id` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Identifier for the recipient's account. Use the first six digits and last four digits of the recipient's account\nnumber. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in\nany way before sending it to the processor. If the field is not required for the transaction, CyberSource does\nnot forward it to the processor.\n\nFor details, see the `recipientInformation.accountId` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n" }, "lastName": { "type": "string", "maxLength": 35, - "description": "Recipient's last name. This field is a _passthrough_, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor. If the field is not required for the transaction,\nCyberSource does not forward it to the processor.\n\nFor details, see the `recipient_lastname` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's last name. This field is a _passthrough_, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor. If the field is not required for the transaction,\nCyberSource does not forward it to the processor.\n\nFor details, see the `recipientInformation.lastName` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n" }, "middleName": { "type": "string", "maxLength": 35, - "description": "Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor. If the field is not required for the transaction,\nCyberSource does not forward it to the processor.\n\nFor details, see the `recipient_middlename` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's middle name. This field is a _passthrough_, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor. If the field is not required for the transaction,\nCyberSource does not forward it to the processor.\n\nFor details, see the `recipientInformation.middleName` field description in the [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n" }, "postalCode": { "type": "string", "maxLength": 10, - "description": "Partial postal code for the recipient's address. For example, if the postal code is **NN5 7SG**, the value for\nthis field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor details, see the `recipient_postal_code` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Partial postal code for the recipient's address. For example, if the postal code is **NN5 7SG**, the value for\nthis field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "dateOfBirth": { "type": "string", "maxLength": 8, - "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Recipient's date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n" }, "beneficiaryId": { "type": "string", @@ -2537,17 +2552,17 @@ "alternateName": { "type": "string", "maxLength": 13, - "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n" + "description": "An alternate name for the merchant.\n" }, "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "address1": { "type": "string", "maxLength": 60, - "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "First line of merchant's address.\n" }, "locality": { "type": "string", @@ -2608,12 +2623,12 @@ "salesOrganizationId": { "type": "string", "maxLength": 11, - "description": "Company ID assigned to an independent sales organization. Get this value from Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 106-116\n- Field: Independent Sales Organization ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\nFor processor-specific information, see the `sales_organization_ID` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Company ID assigned to an independent sales organization. Get this value from Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 106-116\n- Field: Independent Sales Organization ID\n\nThis field is supported for Visa, Mastercard and Discover Transactions.\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" }, "categoryCode": { "type": "integer", "maximum": 9999, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" }, "categoryCodeDomestic": { "type": "integer", @@ -2623,17 +2638,17 @@ "taxId": { "type": "string", "maxLength": 15, - "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n\nFor details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n" }, "cardAcceptorReferenceNumber": { "type": "string", "maxLength": 25, - "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the `card_acceptor_ref_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n" }, "transactionLocalDateTime": { "type": "string", @@ -2757,32 +2772,32 @@ "address1": { "type": "string", "maxLength": 38, - "description": "First line of the sub-merchant's street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "First line of the sub-merchant's street address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "locality": { "type": "string", "maxLength": 21, - "description": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's city.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's state or province.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "region": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nFor processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Sub-merchant's region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n" }, "postalCode": { "type": "string", "maxLength": 15, - "description": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Partial postal code for the sub-merchant's address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "country": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n\nFor details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "email": { "type": "string", @@ -2899,12 +2914,12 @@ "directoryServerTransactionId": { "type": "string", "maxLength": 36, - "description": "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.\nFor Cybersource Through Visanet Gateway:\nThe 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\u2014Directory Server Transaction ID\n" + "description": "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.\nFor Cybersource Through Visanet Gateway:\nThe value for this field corresponds to the following data in the TC 33 capture file3: \nRecord: CP01 TCR7, Position: 114-149, Field: MC AVV Verification\u2014Directory Server Transaction ID\n" }, "paSpecificationVersion": { "type": "string", "maxLength": 1, - "description": "This field contains 3DS version that was used for Secured Consumer Authentication (SCA). For example 3DS secure version 1.0.2 or 2.0.0 is used for Secured Consumer Authentication.\nFor Cybersource Through Visanet Gateway:\nThe value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 113 , Field: MC AVV Verification\u2014Program Protocol\nIt will contain one of the following values:\n- `1` (3D Secure Version 1.0 (3DS 1.0))\n- `2` (EMV 3-D Secure (3DS 2.0))\n\nFor Cybersource connection through Visanet, below are additional values to be supported.\n\n- `2.1.0` (EMV 3D Secure Version 2.1)\n- `2.2.0` (EMV 3D Secure Version 2.2)\n- `2.3.0` (EMV 3D Secure Version 2.3)\n- `2.4.0` (EMV 3D Secure Version 2.4)\n- `2.5.0` (EMV 3D Secure Version 2.5)\n- `2.6.0` (EMV 3D Secure Version 2.6)\n- `2.7.0` (EMV 3D Secure Version 2.7)\n- `2.8.0` (EMV 3D Secure Version 2.8)\n- `2.9.0` (EMV 3D Secure Version 2.9)\n" + "description": "This field contains 3DS version that was used for Secured Consumer Authentication (SCA). \nThe value for this field should be in the format major.minor.patch version.\n\nValid Values are:\n\n- `2.1.0` (EMV 3D Secure Version 2.1)\n- `2.2.0` (EMV 3D Secure Version 2.2)\n- `2.3.0` (EMV 3D Secure Version 2.3)\n- `2.4.0` (EMV 3D Secure Version 2.4)\n- `2.5.0` (EMV 3D Secure Version 2.5)\n- `2.6.0` (EMV 3D Secure Version 2.6)\n- `2.7.0` (EMV 3D Secure Version 2.7)\n- `2.8.0` (EMV 3D Secure Version 2.8)\n- `2.9.0` (EMV 3D Secure Version 2.9)\n\nFor Visa Platform Connect: \nThe value for this field corresponds to the following data in the TC 33 capture file3: \nRecord: CP01 TCR7, Position: 113 , Field: MC AVV Verification\u2014Program Protocol\n\nIt will contain one of the following values:\n- `1` (3D Secure Version 1.x (3DS 1.0))\n- `2` (EMV 3-D Secure (3DS 2.x))\n" }, "authenticationType": { "type": "string", @@ -3203,7 +3218,7 @@ "amexCapnData": { "type": "string", "maxLength": 15, - "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n\nFor details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n" }, "trackData": { "type": "string", @@ -3359,52 +3374,52 @@ "amount": { "type": "string", "maxLength": 12, - "description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet.\n\nFor details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet.\n" }, "frequency": { "type": "string", "maxLength": 1, - "description": "Frequency of the installment payments. When you do not include this field in a request for a\nCrediario installment payment, CyberSource sends a space character to the processor.\n\nFor details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for CyberSource through VisaNet. Possible values:\n- `B`: Biweekly\n- `M`: Monthly\n- `W`: Weekly\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 41\n- Field: Installment Frequency\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Frequency of the installment payments. When you do not include this field in a request for a\nCrediario installment payment, CyberSource sends a space character to the processor.\n\nThis field is supported only for CyberSource through VisaNet. Possible values:\n- `B`: Biweekly\n- `M`: Monthly\n- `W`: Weekly\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 41\n- Field: Installment Frequency\n" }, "planType": { "type": "string", "maxLength": 1, - "description": "#### American Express Direct, Cielo, and CyberSource Latin American Processing\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- `1`: Merchant-funded installment plan\n- `2`: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service.\nFor details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet and American Express\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n#### CyberSource through VisaNet with Visa or Mastercard\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n" + "description": "#### American Express Direct, Cielo, and CyberSource Latin American Processing\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- `1`: Merchant-funded installment plan\n- `2`: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service.\n\n#### CyberSource through VisaNet and American Express\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n#### CyberSource through VisaNet with Visa or Mastercard\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n" }, "sequence": { "type": "integer", "maximum": 99, - "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" }, "totalAmount": { "type": "string", "maxLength": 12, - "description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet.\n\nFor details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet.\n" }, "totalCount": { "type": "integer", "maximum": 99, - "description": "Total number of installments when making payments in installments.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### American Express Direct, Cielo, and Comercio Latino\nThis value is the total number of installments you approved.\n\n#### CyberSource Latin American Processing in Brazil\nThis value is the total number of installments that you approved. The default is 1.\n\n#### All Other Processors\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n#### CyberSource through VisaNet\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + "description": "Total number of installments when making payments in installments.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### American Express Direct, Cielo, and Comercio Latino\nThis value is the total number of installments you approved.\n\n#### CyberSource Latin American Processing in Brazil\nThis value is the total number of installments that you approved. The default is 1.\n\n#### All Other Processors\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n#### CyberSource through VisaNet\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" }, "firstInstallmentDate": { "type": "string", "maxLength": 6, - "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" + "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" }, "invoiceData": { "type": "string", "maxLength": 20, - "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n" + "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n" }, "paymentType": { "type": "string", "maxLength": 1, - "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" + "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" }, "eligibilityInquiry": { "type": "string", "maxLength": 9, - "description": "Indicates whether the authorization request is a Crediario eligibility inquiry.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nSet the value for this field to `Crediario`.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n" + "description": "Indicates whether the authorization request is a Crediario eligibility inquiry.\n\nSet the value for this field to `Crediario`.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n" }, "gracePeriodDuration": { "type": "string", @@ -5118,7 +5133,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "enhancedDataEnabled": { "type": "boolean", @@ -5147,7 +5162,7 @@ "transactionId": { "type": "string", "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" + "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" }, "networkTransactionId": { "type": "string", @@ -5219,12 +5234,12 @@ "code": { "type": "string", "maxLength": 2, - "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\nFor processor-specific information, see the `auth_merchant_advice_code` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n" }, "codeRaw": { "type": "string", "maxLength": 4, - "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n\nFor processor-specific information, see the `auth_merchant_advice_code_raw` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n" }, "nameMatch": { "type": "string", @@ -5499,22 +5514,22 @@ "country": { "type": "string", "maxLength": 3, - "description": "Country in which the card was issued. This information enables you to determine whether the card was issued\ndomestically or internationally. Use the two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase\nPaymentech Solutions.\n\nFor details, see `auth_card_issuer_country` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Country in which the card was issued. This information enables you to determine whether the card was issued\ndomestically or internationally. Use the two-character [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase\nPaymentech Solutions.\n" }, "discretionaryData": { "type": "string", "maxLength": 255, - "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n" }, "countrySpecificDiscretionaryData": { "type": "string", "maxLength": 140, - "description": "Data defined by the issuer.\n\nThis national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan.\nThis subfield contains the Katakana text to be printed on the receipt.\nFor details, see `jpo_issuer_message` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Data defined by the issuer.\n\nThis national use field contains two subfields for information unique to the processing of Visa transactions by members in Japan.\nThis subfield contains the Katakana text to be printed on the receipt.\n" }, "responseCode": { "type": "string", "maxLength": 6, - "description": "This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions.\n\n#### Processors supported:\n - HSBC\n - FDC Nashville Global\n - SIX\n\nCurrently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor.\n\n#### Possible values:\n| Card Type | Response Code | Description |\n| ----------- | ------------- | ------------------------------------------------------------------------------ |\n| VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful |\n| VISA | 001 | Refer to card issuer |\n| VISA | 002 | Refer to card issuer, special condition |\n| VISA | 003 | Invalid merchant or service provider |\n| VISA | 004 | Pickup card | \n| MasterCard | 000 | Approved or completed successfully |\n| MasterCard | 001 | Refer to card issuer |\n| MasterCard | 003 | Invalid merchant |\n| MasterCard | 004 | Capture card |\n| MasterCard | 005 | Do not honor |\n| AMEX | 000 | Approved |\n| AMEX | 001 | Approve with ID |\n| AMEX | 002 | Partial Approval (Prepaid Cards only) |\n| AMEX | 100 | Deny |\n| AMEX | 101 | Expired Card/Invalid Expiration Date |\n| Discover | 000 | Approved or completed successfully |\n| Discover | 001 | Reserved for future USE |\n| Discover | 002 | Reserved for future USE |\n| Discover | 003 | Invalid Merchant |\n| Discover | 004 | Capture Card |\n| .... | ... | For details, see `issuerInformation. responseCode` field description in the [Credit Card Service Using the SCMP API Guide.] (https://developer.cybersource.com/content/dam/docs/cybs/en-us/api-fields/reference/all/rest/api-fields.pdf)| \n" + "description": "This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions.\n\n#### Processors supported:\n - HSBC\n - FDC Nashville Global\n - SIX\n\nCurrently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor.\n\n#### Possible values:\n| Card Type | Response Code | Description |\n| ----------- | ------------- | ------------------------------------------------------------------------------ |\n| VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful |\n| VISA | 001 | Refer to card issuer |\n| VISA | 002 | Refer to card issuer, special condition |\n| VISA | 003 | Invalid merchant or service provider |\n| VISA | 004 | Pickup card | \n| MasterCard | 000 | Approved or completed successfully |\n| MasterCard | 001 | Refer to card issuer |\n| MasterCard | 003 | Invalid merchant |\n| MasterCard | 004 | Capture card |\n| MasterCard | 005 | Do not honor |\n| AMEX | 000 | Approved |\n| AMEX | 001 | Approve with ID |\n| AMEX | 002 | Partial Approval (Prepaid Cards only) |\n| AMEX | 100 | Deny |\n| AMEX | 101 | Expired Card/Invalid Expiration Date |\n| Discover | 000 | Approved or completed successfully |\n| Discover | 001 | Reserved for future USE |\n| Discover | 002 | Reserved for future USE |\n| Discover | 003 | Invalid Merchant |\n| Discover | 004 | Capture Card |\n" }, "pinRequestIndicator": { "type": "string", @@ -5603,12 +5618,12 @@ "prefix": { "type": "string", "maxLength": 6, - "description": "First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n\nFor details, see `token_prefix` field description in [Google Pay Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/)\n" + "description": "First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n" }, "suffix": { "type": "string", "maxLength": 4, - "description": "Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n\nFor details, see `token_suffix` field description in [Google Pay Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/)\n" + "description": "Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n" }, "type": { "type": "string", @@ -5622,12 +5637,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "requestorId": { "type": "string", @@ -5883,12 +5898,12 @@ "category": { "type": "string", "maxLength": 60, - "description": "Categorization of response message from processor\n\nPossible Values:\n- `APPROVED`\n- `ISSUER_WILL_NEVER_APPROVE`\n- `ISSUER_CANT_APPROVE_AT_THIS_TIME`\n- `ISSUER_CANT_APPROVE_WITH_THESE_DETAILS`\n- `GENERIC_ERROR`\n- `OTHERS`\n- `MATCH_NOT_FOUND`\n" + "description": "Categorization of response message from processor\n\nPossible Values:\n- `ISSUER_WILL_NEVER_APPROVE`\n- `ISSUER_CANNOT_APPROVE_AT_THIS_TIME`\n- `ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS`\n- `GENERIC_ERROR`\n- `PAYMENT_INSIGHTS_INTERNAL_ERROR`\n- `OTHERS`\n- `PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND`\n" }, "categoryCode": { "type": "string", "maxLength": 2, - "description": "Categorization Code of response message from processor\n\nPossible Values:\n- `01` : Issuer Will Never Approve\n- `02` : Issuer Can't Approve at this Time\n- `03` : Issuer Can't Approve with these Details\n- `04` : Generic Error\n- `98` : Others\n- `99` : Payment Insights Response Category Match Not Found\n" + "description": "Categorization Code of response message from processor\n\nPossible Values:\n- `01` : ISSUER_WILL_NEVER_APPROVE\n- `02` : ISSUER_CANNOT_APPROVE_AT_THIS_TIME\n- `03` : ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS\n- `04` : GENERIC_ERROR\n- `97` : PAYMENT_INSIGHTS_INTERNAL_ERROR\n- `98` : OTHERS\n- `99` : PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND\n" }, "processorRawName": { "type": "string", @@ -5896,6 +5911,19 @@ "description": "Raw name of the processor used for the transaction processing, especially useful during acquirer swing to see\nwhich processor transaction settled with\n" } } + }, + "orchestration": { + "type": "object", + "properties": { + "infoCodes": { + "type": "array", + "items": { + "type": "string", + "maxLength": 60 + }, + "description": "Infocodes indicating which rules were triggered by the Service Orchestration product.\n" + } + } } } }, @@ -6160,7 +6188,7 @@ "amexCapnData": { "type": "string", "maxLength": 15, - "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n\nFor details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n" }, "terminalId": { "type": "string", @@ -6175,112 +6203,112 @@ "additionalCosts": { "type": "string", "maxLength": 12, - "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n" + "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n" }, "additionalCostsPercentage": { "type": "string", "maxLength": 4, - "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n" + "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n" }, "amount": { "type": "string", "maxLength": 12, - "description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet.\n\nFor details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet.\n" }, "amountFunded": { "type": "string", "maxLength": 12, - "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n" + "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n" }, "amountRequestedPercentage": { "type": "string", "maxLength": 4, - "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n" + "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n" }, "annualFinancingCost": { "type": "string", "maxLength": 7, - "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n" + "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n" }, "annualInterestRate": { "type": "string", "maxLength": 7, - "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n" + "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n" }, "expenses": { "type": "string", "maxLength": 12, - "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n" + "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n" }, "expensesPercentage": { "type": "string", "maxLength": 4, - "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n" + "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n" }, "fees": { "type": "string", "maxLength": 12, - "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n" + "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n" }, "feesPercentage": { "type": "string", "maxLength": 4, - "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n" + "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n" }, "frequency": { "type": "string", "maxLength": 1, - "description": "Frequency of the installment payments. When you do not include this field in a request for a\nCrediario installment payment, CyberSource sends a space character to the processor.\n\nFor details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for CyberSource through VisaNet. Possible values:\n- `B`: Biweekly\n- `M`: Monthly\n- `W`: Weekly\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 41\n- Field: Installment Frequency\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Frequency of the installment payments. When you do not include this field in a request for a\nCrediario installment payment, CyberSource sends a space character to the processor.\n\nThis field is supported only for CyberSource through VisaNet. Possible values:\n- `B`: Biweekly\n- `M`: Monthly\n- `W`: Weekly\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 41\n- Field: Installment Frequency\n" }, "insurance": { "type": "string", "maxLength": 12, - "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n" + "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n" }, "insurancePercentage": { "type": "string", "maxLength": 4, - "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n" + "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n" }, "invoiceData": { "type": "string", "maxLength": 20, - "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n" + "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n" }, "monthlyInterestRate": { "type": "string", "maxLength": 7, - "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n" + "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n" }, "planType": { "type": "string", "maxLength": 1, - "description": "#### American Express Direct, Cielo, and CyberSource Latin American Processing\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- `1`: Merchant-funded installment plan\n- `2`: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service.\nFor details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet and American Express\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n#### CyberSource through VisaNet with Visa or Mastercard\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n" + "description": "#### American Express Direct, Cielo, and CyberSource Latin American Processing\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- `1`: Merchant-funded installment plan\n- `2`: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service.\n\n#### CyberSource through VisaNet and American Express\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n#### CyberSource through VisaNet with Visa or Mastercard\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n" }, "sequence": { "type": "integer", "maximum": 99, - "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" }, "taxes": { "type": "string", "maxLength": 12, - "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n" + "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n" }, "taxesPercentage": { "type": "string", "maxLength": 4, - "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n" + "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n" }, "totalAmount": { "type": "string", "maxLength": 12, - "description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet.\n\nFor details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet.\n" }, "totalCount": { "type": "integer", "maximum": 99, - "description": "Total number of installments when making payments in installments.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### American Express Direct, Cielo, and Comercio Latino\nThis value is the total number of installments you approved.\n\n#### CyberSource Latin American Processing in Brazil\nThis value is the total number of installments that you approved. The default is 1.\n\n#### All Other Processors\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n#### CyberSource through VisaNet\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + "description": "Total number of installments when making payments in installments.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### American Express Direct, Cielo, and Comercio Latino\nThis value is the total number of installments you approved.\n\n#### CyberSource Latin American Processing in Brazil\nThis value is the total number of installments that you approved. The default is 1.\n\n#### All Other Processors\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n#### CyberSource through VisaNet\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" }, "minimumTotalCount": { "type": "string", @@ -6300,7 +6328,7 @@ "firstInstallmentDate": { "type": "string", "maxLength": 6, - "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" + "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" } } }, @@ -6967,7 +6995,7 @@ }, "specificationVersion": { "type": "string", - "description": "This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.\n" + "description": "This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0\n" }, "stepUpUrl": { "type": "string", @@ -10270,7 +10298,7 @@ "transactionId": { "type": "string", "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" + "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" }, "responseCode": { "type": "string", @@ -10293,12 +10321,12 @@ "code": { "type": "string", "maxLength": 2, - "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n\nFor processor-specific information, see the `auth_merchant_advice_code` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "- Merchant should update their retry logic to ensure retry is not attempted for the cards for which Issuer won't approve the transactions and where the retry is allowed.\n- Card Processing Associations provides this data which is being passed through in the following data element irrespective of the Card Associations. Usage of this data must be always associated with the Card Associations card types for merchant processing retry logic.\n- In additions to the Merchant Advice code, Associations also provides the decline response codes which provides the reason for decline. Association response code will be a pass-through value.\n\n#### Processors supported:\n - HSBC\n - Barclays\n - FDC Nash\n - FDI Global\n - Elavon America\n - VPC\n - Rede\n - Payment tech Salem\n\n\n#### Possible values:\n| Card Type | Advice Code | Description |\n| ----------- | ------------- | ------------------------------------------- |\n| VISA | 1 | Issuer never approves |\n| VISA | 2 | Issuer cannot approve at this time |\n| VISA | 3 | Data quality/revalidate payment information |\n| MasterCard | 01 | New account information available |\n| MasterCard | 02 | Try Again Later |\n| MasterCard | 03 | Do Not Try Again |\n| MasterCard | 04 | Token not supported |\n| MasterCard | 21 | Do not honor |\n| MasterCard | 22 | Merchant does not qualify for product code |\n| MasterCard | 24 | Retry after 1 hour |\n| MasterCard | 25 | Retry after 24 hours |\n| MasterCard | 26 | Retry after 2 days |\n| MasterCard | 27 | Retry after 4 days |\n| MasterCard | 28 | Retry after 6 days |\n| MasterCard | 29 | Retry after 8 days |\n| MasterCard | 30 | Retry after 10 days |\n| MasterCard | 40 | Consumer non-reloadable prepaid card |\n| MasterCard | 41 | Consumer single-use virtual card number |\n| MasterCard | 42 | Sanctions score exceeds threshold value |\n| MasterCard | 99 | Do Not Try Again |\n" }, "codeRaw": { "type": "string", "maxLength": 4, - "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\n\nFor processor-specific information, see the `auth_merchant_advice_code_raw` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n" }, "nameMatch": { "type": "string", @@ -10667,7 +10695,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "reconciliationId": { "type": "string", @@ -10695,7 +10723,7 @@ "discretionaryData": { "type": "string", "maxLength": 255, - "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n" } } }, @@ -10736,7 +10764,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" } } } @@ -10935,7 +10963,7 @@ "responseCode": { "type": "string", "maxLength": 6, - "description": "This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions.\n\n#### Processors supported:\n - HSBC\n - FDC Nashville Global\n - SIX\n\nCurrently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor.\n\n#### Possible values:\n| Card Type | Response Code | Description |\n| ----------- | ------------- | ------------------------------------------------------------------------------ |\n| VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful |\n| VISA | 001 | Refer to card issuer |\n| VISA | 002 | Refer to card issuer, special condition |\n| VISA | 003 | Invalid merchant or service provider |\n| VISA | 004 | Pickup card | \n| MasterCard | 000 | Approved or completed successfully |\n| MasterCard | 001 | Refer to card issuer |\n| MasterCard | 003 | Invalid merchant |\n| MasterCard | 004 | Capture card |\n| MasterCard | 005 | Do not honor |\n| AMEX | 000 | Approved |\n| AMEX | 001 | Approve with ID |\n| AMEX | 002 | Partial Approval (Prepaid Cards only) |\n| AMEX | 100 | Deny |\n| AMEX | 101 | Expired Card/Invalid Expiration Date |\n| Discover | 000 | Approved or completed successfully |\n| Discover | 001 | Reserved for future USE |\n| Discover | 002 | Reserved for future USE |\n| Discover | 003 | Invalid Merchant |\n| Discover | 004 | Capture Card |\n| .... | ... | For details, see `issuerInformation. responseCode` field description in the [Credit Card Service Using the SCMP API Guide.] (https://developer.cybersource.com/content/dam/docs/cybs/en-us/api-fields/reference/all/rest/api-fields.pdf)| \n" + "description": "This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions.\n\n#### Processors supported:\n - HSBC\n - FDC Nashville Global\n - SIX\n\nCurrently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor.\n\n#### Possible values:\n| Card Type | Response Code | Description |\n| ----------- | ------------- | ------------------------------------------------------------------------------ |\n| VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful |\n| VISA | 001 | Refer to card issuer |\n| VISA | 002 | Refer to card issuer, special condition |\n| VISA | 003 | Invalid merchant or service provider |\n| VISA | 004 | Pickup card | \n| MasterCard | 000 | Approved or completed successfully |\n| MasterCard | 001 | Refer to card issuer |\n| MasterCard | 003 | Invalid merchant |\n| MasterCard | 004 | Capture card |\n| MasterCard | 005 | Do not honor |\n| AMEX | 000 | Approved |\n| AMEX | 001 | Approve with ID |\n| AMEX | 002 | Partial Approval (Prepaid Cards only) |\n| AMEX | 100 | Deny |\n| AMEX | 101 | Expired Card/Invalid Expiration Date |\n| Discover | 000 | Approved or completed successfully |\n| Discover | 001 | Reserved for future USE |\n| Discover | 002 | Reserved for future USE |\n| Discover | 003 | Invalid Merchant |\n| Discover | 004 | Capture Card |\n" } } }, @@ -11252,7 +11280,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "reconciliationId": { "type": "string", @@ -11280,7 +11308,7 @@ "discretionaryData": { "type": "string", "maxLength": 255, - "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n" } } }, @@ -11321,7 +11349,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" } } } @@ -11506,7 +11534,7 @@ "responseCode": { "type": "string", "maxLength": 6, - "description": "This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions.\n\n#### Processors supported:\n - HSBC\n - FDC Nashville Global\n - SIX\n\nCurrently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor.\n\n#### Possible values:\n| Card Type | Response Code | Description |\n| ----------- | ------------- | ------------------------------------------------------------------------------ |\n| VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful |\n| VISA | 001 | Refer to card issuer |\n| VISA | 002 | Refer to card issuer, special condition |\n| VISA | 003 | Invalid merchant or service provider |\n| VISA | 004 | Pickup card | \n| MasterCard | 000 | Approved or completed successfully |\n| MasterCard | 001 | Refer to card issuer |\n| MasterCard | 003 | Invalid merchant |\n| MasterCard | 004 | Capture card |\n| MasterCard | 005 | Do not honor |\n| AMEX | 000 | Approved |\n| AMEX | 001 | Approve with ID |\n| AMEX | 002 | Partial Approval (Prepaid Cards only) |\n| AMEX | 100 | Deny |\n| AMEX | 101 | Expired Card/Invalid Expiration Date |\n| Discover | 000 | Approved or completed successfully |\n| Discover | 001 | Reserved for future USE |\n| Discover | 002 | Reserved for future USE |\n| Discover | 003 | Invalid Merchant |\n| Discover | 004 | Capture Card |\n| .... | ... | For details, see `issuerInformation. responseCode` field description in the [Credit Card Service Using the SCMP API Guide.] (https://developer.cybersource.com/content/dam/docs/cybs/en-us/api-fields/reference/all/rest/api-fields.pdf)| \n" + "description": "This is the raw Association/Issuer Response Codes. You can use 'issuer/association' response codes to identify when you can retry to authorize a declined transaction and increase successful transaction volumes. You'll receive an association/issuer response code for the majority of transactions.\n\n#### Processors supported:\n - HSBC\n - FDC Nashville Global\n - SIX\n\nCurrently SIX is not receiving Association/Issuer Response Codes here it receives the additional authorization code that must be printed on the receipt when returned by the processor.\n\n#### Possible values:\n| Card Type | Response Code | Description |\n| ----------- | ------------- | ------------------------------------------------------------------------------ |\n| VISA | 000 | Successful approval/completion or that V.I.P. PIN verification is successful |\n| VISA | 001 | Refer to card issuer |\n| VISA | 002 | Refer to card issuer, special condition |\n| VISA | 003 | Invalid merchant or service provider |\n| VISA | 004 | Pickup card | \n| MasterCard | 000 | Approved or completed successfully |\n| MasterCard | 001 | Refer to card issuer |\n| MasterCard | 003 | Invalid merchant |\n| MasterCard | 004 | Capture card |\n| MasterCard | 005 | Do not honor |\n| AMEX | 000 | Approved |\n| AMEX | 001 | Approve with ID |\n| AMEX | 002 | Partial Approval (Prepaid Cards only) |\n| AMEX | 100 | Deny |\n| AMEX | 101 | Expired Card/Invalid Expiration Date |\n| Discover | 000 | Approved or completed successfully |\n| Discover | 001 | Reserved for future USE |\n| Discover | 002 | Reserved for future USE |\n| Discover | 003 | Invalid Merchant |\n| Discover | 004 | Capture Card |\n" } } }, @@ -11739,7 +11767,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "reconciliationId": { "type": "string", @@ -11777,7 +11805,7 @@ "discretionaryData": { "type": "string", "maxLength": 255, - "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n" } } }, @@ -11829,7 +11857,7 @@ "type": { "type": "string", "maxLength": 20, - "description": "Type of loan based on an agreement between you and the issuer.\nExamples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME.\nThis field is supported only for these kinds of payments:\n- BNDES transactions on CyberSource through VisaNet.\n- Installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nSee \"\"Installment Payments on CyberSource through VisaNet,\"\" in the SCMP/SO guide\n\nFor BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR2, Position: 27-46, Field: Loan Type\n\nFor installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR4, Position: 5-24,Field: Financing Type\n" + "description": "Type of loan based on an agreement between you and the issuer.\nExamples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME.\nThis field is supported only for these kinds of payments:\n- BNDES transactions on CyberSource through VisaNet.\n- Installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nFor BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR2, Position: 27-46, Field: Loan Type\n\nFor installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR4, Position: 5-24,Field: Financing Type\n" }, "assetType": { "type": "string", @@ -12006,7 +12034,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -12016,26 +12044,26 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" }, "code": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" }, "applied": { "type": "boolean", - "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n" }, "exemptionCode": { "type": "string", "maxLength": 1, - "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n" } } } @@ -12210,7 +12238,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" }, "productName": { "type": "string", @@ -12232,7 +12260,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "unitOfMeasure": { "type": "string", @@ -12252,7 +12280,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "taxAppliedAfterDiscount": { "type": "string", @@ -12267,7 +12295,7 @@ "taxTypeCode": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "amountIncludesTax": { "type": "boolean", @@ -12309,7 +12337,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -12319,26 +12347,26 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" }, "code": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" }, "applied": { "type": "boolean", - "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n" }, "exemptionCode": { "type": "string", "maxLength": 1, - "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n" } } } @@ -12350,22 +12378,22 @@ "weight": { "type": "string", "maxLength": 9, - "description": "Weight of the item.\n\nFor details, see `weight_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Weight of the item.\n" }, "weightIdentifier": { "type": "string", "maxLength": 1, - "description": "Type of weight.\n\nPossible values:\n- B: Billed weight\n- N: Actual net weight\n\nFor details, see `weight_identifier` offer-level field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Type of weight.\n\nPossible values:\n- B: Billed weight\n- N: Actual net weight\n" }, "weightUnit": { "type": "string", "maxLength": 2, - "description": "Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC).\n\nFor details, see `weight_unit_measurement` offer-level field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Code that specifies the unit of measurement for the weight amount. For example, `OZ` specifies ounce and `LB` specifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC).\n" }, "referenceDataCode": { "type": "string", "maxLength": 150, - "description": "Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field.\n\nPossible values:\n- AN: Client-defined asset code\n- MG: Manufacturer's part number\n- PO: Purchase order number\n- SK: Supplier stock keeping unit number\n- UP: Universal product code\n- VC: Supplier catalog number\n- VP: Vendor part number\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n\nFor details, see `reference_data_#_code` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Code that identifies the value of the corresponding `orderInformation.lineItems[].referenceDataNumber` field.\n\nPossible values:\n- AN: Client-defined asset code\n- MG: Manufacturer's part number\n- PO: Purchase order number\n- SK: Supplier stock keeping unit number\n- UP: Universal product code\n- VC: Supplier catalog number\n- VP: Vendor part number\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" }, "referenceDataNumber": { "type": "string", @@ -12384,7 +12412,7 @@ "giftCardCurrency": { "type": "integer", "maxLength": 3, - "description": "When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the\ncurrency used for the gift card purchase.\n\nFor details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf)\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n" + "description": "When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the\ncurrency used for the gift card purchase.\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n" }, "shippingDestinationTypes": { "type": "string", @@ -12445,14 +12473,14 @@ "type": "array", "items": { "type": "string", - "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n" + "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n" } }, "restrictedExportCountries": { "type": "array", "items": { "type": "string", - "description": "Comma-separated list of ISO country codes for countries to which the product cannot be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\n**Note** If the export field is also present, the content of the `restrictedExportCountries`\nfield overrides the content of export.\n" + "description": "Comma-separated list of ISO country codes for countries to which the product cannot be exported.\n\n**Note** If the export field is also present, the content of the `restrictedExportCountries`\nfield overrides the content of export.\n" } } } @@ -12464,31 +12492,31 @@ "purchaseOrderNumber": { "type": "string", "maxLength": 25, - "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the `user_po` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n" }, "purchaseOrderDate": { "type": "string", "maxLength": 10, - "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the `purchaser_order_date` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n" }, "purchaseContactName": { "type": "string", "maxLength": 36, - "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the `authorized_contact_name` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "The name of the individual or the company contacted for company authorized purchases.\n" }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "vatInvoiceReferenceNumber": { "type": "string", "maxLength": 15, - "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the `vat_invoice_ref_number` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "VAT invoice number associated with the transaction.\n" }, "commodityCode": { "type": "string", "maxLength": 4, - "description": "International description code of the overall order's goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the `summary_commodity_code` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "International description code of the overall order's goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n" }, "transactionAdviceAddendum": { "type": "array", @@ -12593,17 +12621,17 @@ "alternateName": { "type": "string", "maxLength": 13, - "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n" + "description": "An alternate name for the merchant.\n" }, "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "address1": { "type": "string", "maxLength": 60, - "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "First line of merchant's address.\n" }, "locality": { "type": "string", @@ -12659,17 +12687,17 @@ "cardAcceptorReferenceNumber": { "type": "string", "maxLength": 25, - "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the `card_acceptor_ref_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n" }, "categoryCode": { "type": "integer", "maximum": 9999, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n" }, "serviceFeeDescriptor": { "type": "object", @@ -12694,7 +12722,7 @@ "taxId": { "type": "string", "maxLength": 15, - "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n\nFor details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" } } }, @@ -12722,27 +12750,27 @@ "address1": { "type": "string", "maxLength": 38, - "description": "First line of the sub-merchant's street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "First line of the sub-merchant's street address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "locality": { "type": "string", "maxLength": 21, - "description": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's city.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's state or province.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "postalCode": { "type": "string", "maxLength": 15, - "description": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Partial postal code for the sub-merchant's address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "country": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n\nFor details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "email": { "type": "string", @@ -12784,7 +12812,7 @@ "amexCapnData": { "type": "string", "maxLength": 15, - "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n\nFor details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n" } } }, @@ -12839,37 +12867,37 @@ "amount": { "type": "string", "maxLength": 12, - "description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet.\n\nFor details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet.\n" }, "frequency": { "type": "string", "maxLength": 1, - "description": "Frequency of the installment payments. When you do not include this field in a request for a\nCrediario installment payment, CyberSource sends a space character to the processor.\n\nFor details, see `installment_frequency` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for CyberSource through VisaNet. Possible values:\n- `B`: Biweekly\n- `M`: Monthly\n- `W`: Weekly\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 41\n- Field: Installment Frequency\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Frequency of the installment payments. When you do not include this field in a request for a\nCrediario installment payment, CyberSource sends a space character to the processor.\n\nThis field is supported only for CyberSource through VisaNet. Possible values:\n- `B`: Biweekly\n- `M`: Monthly\n- `W`: Weekly\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 41\n- Field: Installment Frequency\n" }, "planType": { "type": "string", "maxLength": 1, - "description": "#### American Express Direct, Cielo, and CyberSource Latin American Processing\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- `1`: Merchant-funded installment plan\n- `2`: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service.\nFor details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet and American Express\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n#### CyberSource through VisaNet with Visa or Mastercard\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n" + "description": "#### American Express Direct, Cielo, and CyberSource Latin American Processing\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- `1`: Merchant-funded installment plan\n- `2`: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service.\n\n#### CyberSource through VisaNet and American Express\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n#### CyberSource through VisaNet with Visa or Mastercard\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n" }, "sequence": { "type": "integer", "maximum": 99, - "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" }, "totalAmount": { "type": "string", "maxLength": 12, - "description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet.\n\nFor details, see \"Installment Payments\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet.\n" }, "totalCount": { "type": "integer", "maximum": 99, - "description": "Total number of installments when making payments in installments.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### American Express Direct, Cielo, and Comercio Latino\nThis value is the total number of installments you approved.\n\n#### CyberSource Latin American Processing in Brazil\nThis value is the total number of installments that you approved. The default is 1.\n\n#### All Other Processors\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n#### CyberSource through VisaNet\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + "description": "Total number of installments when making payments in installments.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### American Express Direct, Cielo, and Comercio Latino\nThis value is the total number of installments you approved.\n\n#### CyberSource Latin American Processing in Brazil\nThis value is the total number of installments that you approved. The default is 1.\n\n#### All Other Processors\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n#### CyberSource through VisaNet\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" }, "firstInstallmentDate": { "type": "string", "maxLength": 6, - "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" + "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" }, "firstInstallmentAmount": { "type": "string", @@ -12879,87 +12907,87 @@ "invoiceData": { "type": "string", "maxLength": 20, - "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n" + "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n" }, "paymentType": { "type": "string", "maxLength": 1, - "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" + "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" }, "additionalCosts": { "type": "string", "maxLength": 12, - "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n" + "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n" }, "additionalCostsPercentage": { "type": "string", "maxLength": 4, - "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n" + "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n" }, "amountFunded": { "type": "string", "maxLength": 12, - "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n" + "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n" }, "amountRequestedPercentage": { "type": "string", "maxLength": 4, - "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n" + "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n" }, "annualFinancingCost": { "type": "string", "maxLength": 7, - "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n" + "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n" }, "annualInterestRate": { "type": "string", "maxLength": 7, - "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n" + "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n" }, "expenses": { "type": "string", "maxLength": 12, - "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n" + "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n" }, "expensesPercentage": { "type": "string", "maxLength": 4, - "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n" + "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n" }, "fees": { "type": "string", "maxLength": 12, - "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n" + "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n" }, "feesPercentage": { "type": "string", "maxLength": 4, - "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n" + "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n" }, "insurance": { "type": "string", "maxLength": 12, - "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n" + "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n" }, "insurancePercentage": { "type": "string", "maxLength": 4, - "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n" + "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n" }, "monthlyInterestRate": { "type": "string", "maxLength": 7, - "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n" + "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n" }, "taxes": { "type": "string", "maxLength": 12, - "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n" + "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n" }, "taxesPercentage": { "type": "string", "maxLength": 4, - "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n" + "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil.\n\nThis field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n" } } }, @@ -14619,7 +14647,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "reconciliationId": { "type": "string", @@ -14651,7 +14679,7 @@ "properties": { "loanPayment": { "type": "boolean", - "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\n\nFor processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n", + "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\n", "default": false } } @@ -14803,12 +14831,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "type": { "type": "string", @@ -14842,7 +14870,7 @@ "securityCode": { "type": "string", "maxLength": 4, - "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n\nFor details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n" }, "securityCodeIndicator": { "type": "string", @@ -14970,6 +14998,16 @@ "description": "Payment mode for the authorization or order transaction. \uf06e INSTANT_TRANSFER \uf06e MANUAL_BANK_TRANSFER \uf06e DELAYED_TRANSFER \uf06e ECHECK \uf06e UNRESTRICTED (default)\u2014this value is available only when configured by PayPal for the merchant. \uf06eINSTANT" } } + }, + "paymentAccountReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 32, + "description": "A Payment Account Reference number (PAR) is a unique reference value associated with a specific card holder PAN.\nIt identifies the card account, not just a card. PAR is a non-payment identifier that can be associated\nto PANs and tokens, as defined by EMVCo. PAR allows all participants in the payments chain to have a single,\nnon-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder\nidentification fields, and transmitted across the payments ecosystem to facilitate card holder identification.\nPAR has a well-defined format (as per the Jan 2016 EMVCo documentation):\n" + } + } } } }, @@ -15079,7 +15117,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -15089,26 +15127,26 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" }, "code": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" }, "applied": { "type": "boolean", - "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n" }, "exemptionCode": { "type": "string", "maxLength": 1, - "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n" } } } @@ -15283,7 +15321,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" }, "productName": { "type": "string", @@ -15305,7 +15343,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "unitOfMeasure": { "type": "string", @@ -15325,7 +15363,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "taxAppliedAfterDiscount": { "type": "string", @@ -15340,7 +15378,7 @@ "taxTypeCode": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "amountIncludesTax": { "type": "boolean", @@ -15382,7 +15420,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -15392,26 +15430,26 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" }, "code": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" }, "applied": { "type": "boolean", - "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n" }, "exemptionCode": { "type": "string", "maxLength": 1, - "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n" } } } @@ -15425,31 +15463,31 @@ "purchaseOrderNumber": { "type": "string", "maxLength": 25, - "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the `user_po` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n" }, "purchaseOrderDate": { "type": "string", "maxLength": 10, - "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the `purchaser_order_date` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n" }, "purchaseContactName": { "type": "string", "maxLength": 36, - "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the `authorized_contact_name` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "The name of the individual or the company contacted for company authorized purchases.\n" }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "vatInvoiceReferenceNumber": { "type": "string", "maxLength": 15, - "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the `vat_invoice_ref_number` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "VAT invoice number associated with the transaction.\n" }, "commodityCode": { "type": "string", "maxLength": 4, - "description": "International description code of the overall order's goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the `summary_commodity_code` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "International description code of the overall order's goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n" }, "transactionAdviceAddendum": { "type": "array", @@ -15554,17 +15592,17 @@ "alternateName": { "type": "string", "maxLength": 13, - "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n" + "description": "An alternate name for the merchant.\n" }, "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "address1": { "type": "string", "maxLength": 60, - "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "First line of merchant's address.\n" }, "locality": { "type": "string", @@ -15620,22 +15658,22 @@ "categoryCode": { "type": "integer", "maximum": 9999, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n" }, "cardAcceptorReferenceNumber": { "type": "string", "maxLength": 25, - "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the `card_acceptor_ref_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n\nFor details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" } } }, @@ -15663,27 +15701,27 @@ "address1": { "type": "string", "maxLength": 38, - "description": "First line of the sub-merchant's street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "First line of the sub-merchant's street address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "locality": { "type": "string", "maxLength": 21, - "description": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's city.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's state or province.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "postalCode": { "type": "string", "maxLength": 15, - "description": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Partial postal code for the sub-merchant's address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "country": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n\nFor details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "email": { "type": "string", @@ -17272,7 +17310,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "reconciliationId": { "type": "string", @@ -17304,7 +17342,7 @@ "properties": { "loanPayment": { "type": "boolean", - "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\n\nFor processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n", + "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\n", "default": false } } @@ -17456,12 +17494,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "type": { "type": "string", @@ -17495,7 +17533,7 @@ "securityCode": { "type": "string", "maxLength": 4, - "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n\nFor details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n" }, "securityCodeIndicator": { "type": "string", @@ -17623,6 +17661,16 @@ "description": "Payment mode for the authorization or order transaction. \uf06e INSTANT_TRANSFER \uf06e MANUAL_BANK_TRANSFER \uf06e DELAYED_TRANSFER \uf06e ECHECK \uf06e UNRESTRICTED (default)\u2014this value is available only when configured by PayPal for the merchant. \uf06eINSTANT" } } + }, + "paymentAccountReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 32, + "description": "A Payment Account Reference number (PAR) is a unique reference value associated with a specific card holder PAN.\nIt identifies the card account, not just a card. PAR is a non-payment identifier that can be associated\nto PANs and tokens, as defined by EMVCo. PAR allows all participants in the payments chain to have a single,\nnon-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder\nidentification fields, and transmitted across the payments ecosystem to facilitate card holder identification.\nPAR has a well-defined format (as per the Jan 2016 EMVCo documentation):\n" + } + } } } }, @@ -17732,7 +17780,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -17742,26 +17790,26 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" }, "code": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" }, "applied": { "type": "boolean", - "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n" }, "exemptionCode": { "type": "string", "maxLength": 1, - "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n" } } } @@ -17936,7 +17984,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" }, "productName": { "type": "string", @@ -17958,7 +18006,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "unitOfMeasure": { "type": "string", @@ -17978,7 +18026,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "taxAppliedAfterDiscount": { "type": "string", @@ -17993,7 +18041,7 @@ "taxTypeCode": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "amountIncludesTax": { "type": "boolean", @@ -18035,7 +18083,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -18045,26 +18093,26 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" }, "code": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" }, "applied": { "type": "boolean", - "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n" }, "exemptionCode": { "type": "string", "maxLength": 1, - "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n" } } } @@ -18078,31 +18126,31 @@ "purchaseOrderNumber": { "type": "string", "maxLength": 25, - "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the `user_po` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n" }, "purchaseOrderDate": { "type": "string", "maxLength": 10, - "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the `purchaser_order_date` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n" }, "purchaseContactName": { "type": "string", "maxLength": 36, - "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the `authorized_contact_name` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "The name of the individual or the company contacted for company authorized purchases.\n" }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "vatInvoiceReferenceNumber": { "type": "string", "maxLength": 15, - "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the `vat_invoice_ref_number` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "VAT invoice number associated with the transaction.\n" }, "commodityCode": { "type": "string", "maxLength": 4, - "description": "International description code of the overall order's goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the `summary_commodity_code` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "International description code of the overall order's goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n" }, "transactionAdviceAddendum": { "type": "array", @@ -18207,17 +18255,17 @@ "alternateName": { "type": "string", "maxLength": 13, - "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n" + "description": "An alternate name for the merchant.\n" }, "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "address1": { "type": "string", "maxLength": 60, - "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "First line of merchant's address.\n" }, "locality": { "type": "string", @@ -18273,22 +18321,22 @@ "categoryCode": { "type": "integer", "maximum": 9999, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n" }, "cardAcceptorReferenceNumber": { "type": "string", "maxLength": 25, - "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the `card_acceptor_ref_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n\nFor details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" } } }, @@ -18316,27 +18364,27 @@ "address1": { "type": "string", "maxLength": 38, - "description": "First line of the sub-merchant's street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "First line of the sub-merchant's street address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "locality": { "type": "string", "maxLength": 21, - "description": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's city.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's state or province.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "postalCode": { "type": "string", "maxLength": 15, - "description": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Partial postal code for the sub-merchant's address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "country": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n\nFor details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "email": { "type": "string", @@ -19902,7 +19950,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "reconciliationId": { "type": "string", @@ -19954,7 +20002,7 @@ "properties": { "loanPayment": { "type": "boolean", - "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\n\nFor processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n", + "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- `true`: Loan payment\n- `false`: (default) Not a loan payment\n", "default": false } } @@ -20024,7 +20072,7 @@ "type": { "type": "string", "maxLength": 20, - "description": "Type of loan based on an agreement between you and the issuer.\nExamples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME.\nThis field is supported only for these kinds of payments:\n- BNDES transactions on CyberSource through VisaNet.\n- Installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nSee \"\"Installment Payments on CyberSource through VisaNet,\"\" in the SCMP/SO guide\n\nFor BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR2, Position: 27-46, Field: Loan Type\n\nFor installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR4, Position: 5-24,Field: Financing Type\n" + "description": "Type of loan based on an agreement between you and the issuer.\nExamples: AGROCUSTEIO, AGRO-INVEST, BNDES-Type1, CBN, FINAME.\nThis field is supported only for these kinds of payments:\n- BNDES transactions on CyberSource through VisaNet.\n- Installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nFor BNDES transactions, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR2, Position: 27-46, Field: Loan Type\n\nFor installment payments with Mastercard in Brazil, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP07 TCR4, Position: 5-24,Field: Financing Type\n" }, "assetType": { "type": "string", @@ -20186,12 +20234,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "type": { "type": "string", @@ -20225,7 +20273,7 @@ "securityCode": { "type": "string", "maxLength": 4, - "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n\nFor details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n" }, "securityCodeIndicator": { "type": "string", @@ -20353,6 +20401,16 @@ "description": "Payment mode for the authorization or order transaction. \uf06e INSTANT_TRANSFER \uf06e MANUAL_BANK_TRANSFER \uf06e DELAYED_TRANSFER \uf06e ECHECK \uf06e UNRESTRICTED (default)\u2014this value is available only when configured by PayPal for the merchant. \uf06eINSTANT" } } + }, + "paymentAccountReference": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 32, + "description": "A Payment Account Reference number (PAR) is a unique reference value associated with a specific card holder PAN.\nIt identifies the card account, not just a card. PAR is a non-payment identifier that can be associated\nto PANs and tokens, as defined by EMVCo. PAR allows all participants in the payments chain to have a single,\nnon-sensitive value assigned to a consumer. This value can be used in place of sensitive card holder\nidentification fields, and transmitted across the payments ecosystem to facilitate card holder identification.\nPAR has a well-defined format (as per the Jan 2016 EMVCo documentation):\n" + } + } } } }, @@ -20462,7 +20520,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -20472,26 +20530,26 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" }, "code": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" }, "applied": { "type": "boolean", - "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n" }, "exemptionCode": { "type": "string", "maxLength": 1, - "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n" } } } @@ -20666,7 +20724,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" }, "productName": { "type": "string", @@ -20688,7 +20746,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "unitOfMeasure": { "type": "string", @@ -20708,7 +20766,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "taxAppliedAfterDiscount": { "type": "string", @@ -20723,7 +20781,7 @@ "taxTypeCode": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "amountIncludesTax": { "type": "boolean", @@ -20765,7 +20823,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -20775,26 +20833,26 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" }, "code": { "type": "string", "maxLength": 4, - "description": "Type of tax being applied to the item.\n\nFor possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/):\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" + "description": "Type of tax being applied to the item.\n\n#### FDC Nashville Global\n- `alternate_tax_type_applied`\n- `alternate_tax_type_identifier`\n\n#### Worldpay VAP\n- `alternate_tax_type_identifier`\n\n#### RBS WorldPay Atlanta\n- `tax_type_applied`\n\n#### TSYS Acquiring Solutions\n- `tax_type_applied`\n- `local_tax_indicator`\n\n#### Chase Paymentech Solutions\n- `tax_type_applied`\n\n#### Elavon Americas\n- `local_tax_indicator`\n\n#### FDC Compass\n- `tax_type_applied`\n\n#### OmniPay Direct\n- `local_tax_indicator`\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n\nFor processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" }, "applied": { "type": "boolean", - "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n\nFor processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is\nincluded in the request.\n\nPossible values:\n- `false`: alternate tax amount is not included in the request.\n- `true`: alternate tax amount is included in the request.\n" }, "exemptionCode": { "type": "string", "maxLength": 1, - "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n\nFor possible values and important information for using this field, see _Appendix B, \"Exemption\nStatus Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Status code for exemption from sales and use tax. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor.\n" } } } @@ -20808,31 +20866,31 @@ "purchaseOrderNumber": { "type": "string", "maxLength": 25, - "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the `user_po` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n" }, "purchaseOrderDate": { "type": "string", "maxLength": 10, - "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the `purchaser_order_date` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n" }, "purchaseContactName": { "type": "string", "maxLength": 36, - "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the `authorized_contact_name` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "The name of the individual or the company contacted for company authorized purchases.\n" }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "vatInvoiceReferenceNumber": { "type": "string", "maxLength": 15, - "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the `vat_invoice_ref_number` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "VAT invoice number associated with the transaction.\n" }, "commodityCode": { "type": "string", "maxLength": 4, - "description": "International description code of the overall order's goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the `summary_commodity_code` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "International description code of the overall order's goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n" }, "transactionAdviceAddendum": { "type": "array", @@ -20937,17 +20995,17 @@ "alternateName": { "type": "string", "maxLength": 13, - "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n" + "description": "An alternate name for the merchant.\n" }, "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "address1": { "type": "string", "maxLength": 60, - "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "First line of merchant's address.\n" }, "locality": { "type": "string", @@ -21003,22 +21061,22 @@ "categoryCode": { "type": "integer", "maximum": 9999, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" }, "vatRegistrationNumber": { "type": "string", "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n" }, "cardAcceptorReferenceNumber": { "type": "string", "maxLength": 25, - "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the `card_acceptor_ref_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n" }, "taxId": { "type": "string", "maxLength": 15, - "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n\nFor details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" } } }, @@ -21046,27 +21104,27 @@ "address1": { "type": "string", "maxLength": 38, - "description": "First line of the sub-merchant's street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "First line of the sub-merchant's street address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "locality": { "type": "string", "maxLength": 21, - "description": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's city.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's state or province.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "postalCode": { "type": "string", "maxLength": 15, - "description": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Partial postal code for the sub-merchant's address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "country": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n\nFor details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "email": { "type": "string", @@ -21166,7 +21224,7 @@ "amexCapnData": { "type": "string", "maxLength": 15, - "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n\nFor details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n" }, "trackData": { "type": "string", @@ -21322,7 +21380,7 @@ "planType": { "type": "string", "maxLength": 1, - "description": "#### American Express Direct, Cielo, and CyberSource Latin American Processing\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- `1`: Merchant-funded installment plan\n- `2`: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service.\nFor details, see `installment_plan_type` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet and American Express\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n#### CyberSource through VisaNet with Visa or Mastercard\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n" + "description": "#### American Express Direct, Cielo, and CyberSource Latin American Processing\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- `1`: Merchant-funded installment plan\n- `2`: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service.\n\n#### CyberSource through VisaNet and American Express\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n#### CyberSource through VisaNet with Visa or Mastercard\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n" } } }, @@ -25123,9 +25181,9 @@ "type": "object", "properties": { "paymentId": { - "type": "string", + "type": "object", "maxLength": 28, - "description": "This field is to accept the id of credit/capture in the body of L1 requests so the type of void can be identified and processed correctly downstream." + "description": "This field is to accept the id of credit/capture in the body of the requests so the type of void can be identified and processed correctly." } } } @@ -26325,7 +26383,7 @@ "transactionId": { "type": "string", "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" + "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" }, "tradeNumber": { "type": "string", @@ -26742,32 +26800,32 @@ "address1": { "type": "string", "maxLength": 38, - "description": "First line of the sub-merchant's street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "First line of the sub-merchant's street address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "locality": { "type": "string", "maxLength": 21, - "description": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's city.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's state or province.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "region": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nFor processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Sub-merchant's region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n" }, "postalCode": { "type": "string", "maxLength": 15, - "description": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Partial postal code for the sub-merchant's address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "country": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n\nFor details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "email": { "type": "string", @@ -26838,7 +26896,7 @@ "firstInstallmentDate": { "type": "string", "maxLength": 6, - "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" + "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" }, "identifier": { "type": "string", @@ -26863,7 +26921,7 @@ "paymentType": { "type": "string", "maxLength": 1, - "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" + "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" }, "preferredDay": { "type": "string", @@ -26873,7 +26931,7 @@ "sequence": { "type": "integer", "maximum": 99, - "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" } } }, @@ -26891,7 +26949,7 @@ "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "locality": { "type": "string", @@ -26907,7 +26965,7 @@ "categoryCode": { "type": "integer", "maximum": 9999, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" }, "administrativeArea": { "type": "string", @@ -27081,12 +27139,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "number": { "type": "string", @@ -27177,7 +27235,7 @@ "merchantCustomerId": { "type": "string", "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### SEPA/BACS\nRequired for Create Mandate and Import Mandate\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the `customer_account_id` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n#### SEPA/BACS\nRequired for Create Mandate and Import Mandate\n\n#### Comercio Latino\nFor recurring payments in Mexico, the value is the customer's contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n#### Worldpay VAP\nFor a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n" }, "dateOfBirth": { "type": "string", @@ -27903,32 +27961,32 @@ "address1": { "type": "string", "maxLength": 38, - "description": "First line of the sub-merchant's street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "First line of the sub-merchant's street address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "locality": { "type": "string", "maxLength": 21, - "description": "Sub-merchant's city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's city.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Sub-merchant's state or province.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "region": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nFor processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Sub-merchant's region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n" }, "postalCode": { "type": "string", "maxLength": 15, - "description": "Partial postal code for the sub-merchant's address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" + "description": "Partial postal code for the sub-merchant's address.\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file5.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "country": { "type": "string", "maxLength": 3, - "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n\nFor details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Sub-merchant's country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).\n\n#### CyberSource through VisaNet\nThe value for this field does not map to the TC 33 capture file.\n\n#### FDC Compass\nThis value must consist of uppercase characters.\n" }, "email": { "type": "string", @@ -27999,7 +28057,7 @@ "firstInstallmentDate": { "type": "string", "maxLength": 6, - "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" + "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" }, "identifier": { "type": "string", @@ -28024,7 +28082,7 @@ "paymentType": { "type": "string", "maxLength": 1, - "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" + "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" }, "preferredDay": { "type": "string", @@ -28034,7 +28092,7 @@ "sequence": { "type": "integer", "maximum": 99, - "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" } } }, @@ -28052,7 +28110,7 @@ "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "locality": { "type": "string", @@ -28068,7 +28126,7 @@ "categoryCode": { "type": "integer", "maximum": 9999, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" }, "administrativeArea": { "type": "string", @@ -28242,12 +28300,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "number": { "type": "string", @@ -29211,7 +29269,7 @@ "firstInstallmentDate": { "type": "string", "maxLength": 6, - "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" + "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" }, "identifier": { "type": "string", @@ -29236,7 +29294,7 @@ "paymentType": { "type": "string", "maxLength": 1, - "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nFor details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" + "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" }, "preferredDay": { "type": "string", @@ -29246,7 +29304,7 @@ "sequence": { "type": "integer", "maximum": 99, - "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\nFor details, see \"Installment Payments\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\nFor details, see \"Chase Paymentech Solutions Merchant Descriptors\" and \"FDC Compass Merchant Descriptors\" in the [Merchant Descriptors Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + "description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" } } }, @@ -29264,7 +29322,7 @@ "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "locality": { "type": "string", @@ -29280,7 +29338,7 @@ "categoryCode": { "type": "integer", "maximum": 9999, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" }, "administrativeArea": { "type": "string", @@ -29454,12 +29512,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "number": { "type": "string", @@ -29876,7 +29934,7 @@ "taxAmount": { "type": "string", "maxLength": 10, - "description": "Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation. \n" + "description": "Total tax amount. When the purchaseTotals_ taxAmount and ap_subtotalAmount fields are included in the request, do not include the tax amount as part of the subtotal amount calculation.\n" }, "insuranceAmount": { "type": "string", @@ -29956,7 +30014,7 @@ "transactionId": { "type": "string", "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" + "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" }, "responseDetails": { "type": "string", @@ -30523,7 +30581,7 @@ "company": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n" }, "address1": { "type": "string", @@ -30683,7 +30741,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "discountAmount": { "type": "string", @@ -30703,7 +30761,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "totalAmount": { "type": "string", @@ -30713,7 +30771,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" }, "productDescription": { "type": "string", @@ -30823,17 +30881,17 @@ "alternateName": { "type": "string", "maxLength": 13, - "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n" + "description": "An alternate name for the merchant.\n" }, "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "address1": { "type": "string", "maxLength": 60, - "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "First line of merchant's address.\n" }, "locality": { "type": "string", @@ -31332,7 +31390,7 @@ "transactionId": { "type": "string", "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" + "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" }, "paymentUrl": { "type": "string", @@ -31668,7 +31726,7 @@ "company": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n" }, "address1": { "type": "string", @@ -31828,7 +31886,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "discountAmount": { "type": "string", @@ -31848,7 +31906,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "totalAmount": { "type": "string", @@ -31858,7 +31916,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" }, "productDescription": { "type": "string", @@ -31968,17 +32026,17 @@ "alternateName": { "type": "string", "maxLength": 13, - "description": "An alternate name for the merchant.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\n" + "description": "An alternate name for the merchant.\n" }, "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "address1": { "type": "string", "maxLength": 60, - "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "First line of merchant's address.\n" }, "locality": { "type": "string", @@ -32484,7 +32542,7 @@ "transactionId": { "type": "string", "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" + "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" }, "paymentUrl": { "type": "string", @@ -32915,7 +32973,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -33018,7 +33076,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -33026,7 +33084,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -33179,7 +33237,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -33812,7 +33870,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -33915,7 +33973,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -33923,7 +33981,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -34076,7 +34134,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -35027,7 +35085,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -35130,7 +35188,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -35138,7 +35196,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -35291,7 +35349,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -36239,7 +36297,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -36342,7 +36400,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -36350,7 +36408,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -36503,7 +36561,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -37145,7 +37203,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -37248,7 +37306,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -37256,7 +37314,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -37409,7 +37467,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -41581,7 +41639,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -41684,7 +41742,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -41692,7 +41750,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -41845,7 +41903,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -42226,7 +42284,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -42329,7 +42387,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -42337,7 +42395,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -42490,7 +42548,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -43404,7 +43462,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -43507,7 +43565,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -43515,7 +43573,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -43668,7 +43726,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -44397,7 +44455,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -44500,7 +44558,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -44508,7 +44566,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -44661,7 +44719,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -45353,7 +45411,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -45456,7 +45514,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -45464,7 +45522,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -45617,7 +45675,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -45994,7 +46052,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -46097,7 +46155,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -46105,7 +46163,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -46258,7 +46316,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -47486,7 +47544,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -47589,7 +47647,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -47597,7 +47655,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -47750,7 +47808,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -48113,7 +48171,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -48216,7 +48274,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -48224,7 +48282,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -48377,7 +48435,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -49141,7 +49199,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -49244,7 +49302,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -49252,7 +49310,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -49405,7 +49463,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -50088,7 +50146,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -50191,7 +50249,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -50199,7 +50257,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -50352,7 +50410,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -50729,7 +50787,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -50832,7 +50890,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -50840,7 +50898,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -50993,7 +51051,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -52050,7 +52108,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -52370,7 +52428,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -52678,7 +52736,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -53332,7 +53390,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -53973,7 +54031,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -54307,7 +54365,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -55568,7 +55626,7 @@ "currency": { "type": "string", "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n" }, "dateOfBirth": { "type": "string", @@ -55671,7 +55729,7 @@ "properties": { "billPaymentProgramEnabled": { "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n" }, "bankTransferOptions": { "type": "object", @@ -55679,7 +55737,7 @@ "SECCode": { "type": "string", "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible Values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n" } } } @@ -55832,7 +55890,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -56475,7 +56533,7 @@ }, "routingNumber": { "type": "string", - "description": "Bank routing number. This is also called the transit number.\n\nFor details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n" + "description": "Bank routing number. This is also called the transit number.\n" } } }, @@ -57825,12 +57883,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" } } }, @@ -57934,7 +57992,7 @@ "totalAmount": { "type": "string", "maxLength": 19, - "description": "Grand total for the order. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### DCC for First Data\nNot used.\n" + "description": "Grand total for the order. You can include a decimal point (.), but no other special characters.\nCyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. \nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. \n\n#### Card Present\nRequired to include either this field or `orderInformation.lineItems[].unitPrice` for the order.\n\n#### Invoicing\nRequired for creating a new invoice.\n\n#### PIN Debit\nAmount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.\n\nRequired field for PIN Debit purchase and PIN Debit credit requests.\nOptional field for PIN Debit reversal requests.\n\n#### GPX\nThis field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [REST API Fields Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html)\n\n#### DCC for First Data\nNot used.\nFor details, see [REST API Field Guide](https://developer.cybersource.com/docs/cybs/en-us/api-fields/reference/all/rest/api-fields/order-info-aa/order-info-amount-details-total-amount.html)\n" } } }, @@ -58063,7 +58121,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "quantity": { "type": "integer", @@ -58075,7 +58133,7 @@ "giftCardCurrency": { "type": "integer", "maxLength": 3, - "description": "When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the\ncurrency used for the gift card purchase.\n\nFor details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf)\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n" + "description": "When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the\ncurrency used for the gift card purchase.\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n" }, "productSKU": { "type": "string", @@ -58099,7 +58157,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" }, "gift": { "type": "boolean", @@ -58170,14 +58228,14 @@ "type": "array", "items": { "type": "string", - "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n" + "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n" } }, "restrictedExportCountries": { "type": "array", "items": { "type": "string", - "description": "Comma-separated list of ISO country codes for countries to which the product cannot be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\n**Note** If the export field is also present, the content of the `restrictedExportCountries`\nfield overrides the content of export.\n" + "description": "Comma-separated list of ISO country codes for countries to which the product cannot be exported.\n\n**Note** If the export field is also present, the content of the `restrictedExportCountries`\nfield overrides the content of export.\n" } } } @@ -59720,7 +59778,7 @@ }, "specificationVersion": { "type": "string", - "description": "This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.\n" + "description": "This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0\n" }, "stepUpUrl": { "type": "string", @@ -60717,12 +60775,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "number": { "type": "string", @@ -60777,7 +60835,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "visaCheckoutId": { "type": "string", @@ -61284,7 +61342,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "quantity": { "type": "integer", @@ -61296,7 +61354,7 @@ "giftCardCurrency": { "type": "integer", "maxLength": 3, - "description": "When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the\ncurrency used for the gift card purchase.\n\nFor details, see `pa_gift_card_currency` field description in [CyberSource Payer Authentication Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/Payer_Authentication_SCMP_API.pdf)\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n" + "description": "When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the\ncurrency used for the gift card purchase.\n\nFor the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n" }, "productSKU": { "type": "string", @@ -61557,12 +61615,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "cryptogram": { "type": "string", @@ -61572,7 +61630,7 @@ "securityCode": { "type": "string", "maxLength": 4, - "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n\nFor details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n" }, "number": { "type": "string", @@ -61631,7 +61689,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "visaCheckoutId": { "type": "string", @@ -62540,7 +62598,7 @@ }, "specificationVersion": { "type": "string", - "description": "This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.\n" + "description": "This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0\n" }, "stepUpUrl": { "type": "string", @@ -63068,7 +63126,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "visaCheckoutId": { "type": "string", @@ -63145,12 +63203,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "number": { "type": "string", @@ -63439,7 +63497,7 @@ }, "specificationVersion": { "type": "string", - "description": "This field contains the 3D Secure version that was used to process the transaction. For example, 1.0.2 or 2.0.0.\n" + "description": "This field contains the 3D Secure version that was used to process the transaction. For example: 2.2.0\n" }, "threeDSServerTransactionId": { "type": "string", @@ -63791,7 +63849,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" } } } @@ -65320,7 +65378,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "quantity": { "type": "integer", @@ -65347,7 +65405,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" } } } @@ -66208,20 +66266,20 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "allowedExportCountries": { "type": "array", "items": { "type": "string", - "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n" + "description": "Comma-separated list of ISO country codes for countries to which the product can be exported.\n\nIf country codes are not specified, or if this field is not included, the U.S. government's country\ncode list is used.\n\n**Note** The default list of countries restricted by the U.S. always applies. Any country not\nspecifically added to the export field is considered restricted.\n" } }, "restrictedExportCountries": { "type": "array", "items": { "type": "string", - "description": "Comma-separated list of ISO country codes for countries to which the product cannot be exported.\n\nFor all possible values, see the \"Country and Territory Postal System Categories\" section in the [CyberSource Verification Services Using the SCMP API.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Verification_Svcs_SCMP_API/html/)\n\n**Note** If the export field is also present, the content of the `restrictedExportCountries`\nfield overrides the content of export.\n" + "description": "Comma-separated list of ISO country codes for countries to which the product cannot be exported.\n\n**Note** If the export field is also present, the content of the `restrictedExportCountries`\nfield overrides the content of export.\n" } }, "quantity": { @@ -66249,7 +66307,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" } } } @@ -67032,7 +67090,7 @@ "categoryCode": { "type": "integer", "maximum": 9999, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company's cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" }, "submitLocalDateTime": { "type": "string", @@ -67041,7 +67099,7 @@ "vatRegistrationNumber": { "type": "string", "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n" }, "merchantDescriptor": { "type": "object", @@ -67072,12 +67130,12 @@ "contact": { "type": "string", "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" + "description": "Contact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" }, "address1": { "type": "string", "maxLength": 60, - "description": "First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "First line of merchant's address.\n" } } } @@ -67252,12 +67310,12 @@ "networkRoutingOrder": { "type": "string", "maxLength": 30, - "description": "This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only.\nThe networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order.\nNote: Supported only in US for domestic transactions involving Push Payments Gateway Service.\n\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order.\nIf an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. \nIf an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. \n\nFor details, see the `network_order` field description in [BIN Lookup Service Using the SCMP API.](http://apps.cybersource.com/library/documentation/BIN_Lookup/BIN_Lookup_SCMP_API/html/)\n" + "description": "This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only.\nThe networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order.\nNote: Supported only in US for domestic transactions involving Push Payments Gateway Service.\n\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order.\nIf an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer's preference. \nIf an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer's routing priorities. \n" }, "commerceIndicator": { "type": "string", "maxLength": 13, - "description": "Type of transaction.\n\nValue for an OCT transaction:\n- `internet`\n\nFor details, see the `e_commerce_indicator` field description in [Payouts Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SCMP/html/)\n" + "description": "Type of transaction.\n\nValue for an OCT transaction:\n- `internet`\n" }, "reconciliationId": { "type": "string", @@ -67405,12 +67463,12 @@ "expirationMonth": { "type": "string", "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\nFor processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n" }, "expirationYear": { "type": "string", "maxLength": 4, - "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\n\n#### Barclays and Streamline\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through\n3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n#### Encoded Account Numbers\nFor encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`.\n\n#### FDC Nashville Global and FDMS South\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n" }, "type": { "type": "string", @@ -67444,7 +67502,7 @@ "securityCode": { "type": "string", "maxLength": 4, - "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n\nFor details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n" }, "securityCodeIndicator": { "type": "string", @@ -68125,6 +68183,11 @@ "description": "Use a 3-character alpha currency code for destination currency of the funds transfer.\n\nYellow Pepper\nSupported for cross border funds transfers.\n\nISO standard currencies: http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf\n" } } + }, + "enablerId": { + "type": "string", + "maxLength": 15, + "description": "Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers.\n" } } }, @@ -72999,6 +73062,564 @@ } } }, + "/bin/v1/binlookup": { + "post": { + "summary": "BIN Lookup API", + "description": "The BIN Lookup Service is a versatile business tool that provides card network agnostic solution designed to ensure frictionless transaction experience by utilizing up-to-date Bank Identification Number (BIN) attributes sourced from multiple global and regional data sources.\nThis service helps to improve authorization rates by helping to route transactions to the best-suited card network, minimizes fraud through card detail verification and aids in regulatory compliance by identifying card properties. The service is flexible and provides businesses \nwith a flexible choice of inputs such as primary account number (PAN), network token from major networks which includes device PAN (DPAN), and all types of tokens generated via CyberSource Token Management Service (TMS).\nCurrently, the range of available credentials is contingent on the networks enabled for the business entity. Therefore, the network information specified in this documentation is illustrative and subject to personalized offerings for each reseller or merchant.\n", + "tags": [ + "Bin Lookup" + ], + "operationId": "getAccountInfo", + "x-devcenter-metaData": { + "categoryTag": "Bin_Lookup", + "developerGuides": "https://developer.cybersource.com/docs/cybs/en-us/bin-lookup/developer/all/rest/bin-lookup/bin-lookup-intro.html", + "firstLevelApiLifeCycle": "beta", + "secondLevelApiLifeCycle": "beta", + "apiLifeCycle": "beta", + "disableProcessorDropDown": true, + "SDK_ONLY_AddDisclaimer": true + }, + "parameters": [ + { + "name": "createBinLookupRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\n**Note** When you see a solutionId of 999 in reports, the solutionId that was submitted is incorrect.\n" + } + } + }, + "applicationName": { + "type": "string", + "description": "The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.\n" + }, + "applicationVersion": { + "type": "string", + "description": "Version of the CyberSource application or integration used for a transaction.\n" + }, + "applicationUser": { + "type": "string", + "description": "The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.\n" + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 20, + "description": "The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field\nfor encoded account numbers.\n\n#### FDMS Nashville\nRequired. String (19)\n\n#### GPX\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n\n#### All other processors\nRequired if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured\nfor relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine\nwhether a field is required for the transaction you are requesting.\n" + } + } + }, + "customer": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the Customer token used in the transaction.\nWhen you include this value in your request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n", + "minLength": 1, + "maxLength": 32 + } + } + }, + "paymentInstrument": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the Payment Instrument token used in the transaction.\nWhen you include this value in your request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n", + "minLength": 1, + "maxLength": 32 + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the Instrument Identifier token used in the transaction.\nWhen you include this value in your request, many of the fields that can be supplied for an authorization or credit\nbecome optional.\n", + "minLength": 12, + "maxLength": 32 + } + } + } + } + }, + "tokenInformation": { + "type": "object", + "properties": { + "jti": { + "type": "string", + "maxLength": 64, + "description": "TMS Transient Token, 64 hexadecimal id value representing captured payment credentials (including Sensitive Authentication Data, e.g. CVV).\n" + }, + "transientTokenJwt": { + "type": "string", + "description": "Flex API Transient Token encoded as JWT (JSON Web Token), e.g. Flex microform or Unified Payment checkout result.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "binSource": { + "type": "string", + "description": "Bin Source File Identifier.\n\nPossible values:\n- itmx\n- rupay\n" + }, + "payoutOptions": { + "type": "object", + "description": "Payout fields request parameters\n", + "properties": { + "payoutInquiry": { + "type": "boolean", + "description": "If `true` then provide attributes related to fund transfer/payouts. If payout information not found then response will have standard account lookup.\n\nPossible values:\n- true\n- false\n" + }, + "networkId": { + "type": "string", + "description": "The networks specified in this field must be a subset of the information provided during program enrollment\n \nPossible values:\n- 0020 : Accel/Exchange\n- 0024 : CU24\n- 0003 : Interlink\n- 0016 : Maestro\n- 0018 : NYCE\n- 0027 : NYCE\n- 0009 : Pulse\n- 0017 : Pulse\n- 0019 : Pulse\n- 0008 : Star\n- 0010 : Star\n- 0011 : Star\n- 0012 : Star\n- 0015 : Star\n- 0002 : Visa/PLUS\n" + }, + "acquirerBin": { + "type": "string", + "description": "BIN under which the Funds Transfer application is registered. This must match the information provided during enrollment.\n" + } + } + } + } + } + } + } + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number generated by Cybersource to identify the submitted request. Returned by all services.\nIt is also appended to the endpoint of the resource.\nOn incremental authorizations, this value with be the same as the identification number returned in the original authorization response.\n" + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - COMPLETED\n - MULTIPLE\n - NO MATCH\n" + }, + "paymentAccountInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n" + }, + "maxLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the max length of the card.\n" + }, + "credentialType": { + "type": "string", + "maxLength": 5, + "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n" + }, + "brands": { + "description": "Array of brands", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 3, + "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n" + }, + "brandName": { + "type": "string", + "maxLength": 20, + "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n" + } + } + } + } + } + }, + "features": { + "type": "object", + "properties": { + "accountFundingSource": { + "type": "string", + "maxLength": 20, + "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n" + }, + "accountFundingSourceSubType": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n" + }, + "cardProduct": { + "type": "string", + "maxLength": 50, + "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n" + }, + "messageType": { + "type": "string", + "maxLength": 1, + "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n" + }, + "acceptanceLevel": { + "type": "string", + "maxLength": 2, + "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n" + }, + "cardPlatform": { + "type": "string", + "maxLength": 20, + "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n" + }, + "comboCard": { + "type": "string", + "maxLength": 1, + "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n" + }, + "corporatePurchase": { + "type": "boolean", + "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n" + }, + "healthCard": { + "type": "boolean", + "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n" + } + } + }, + "network": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n" + } + } + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 200, + "description": "This field contains the issuer name.\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n" + }, + "binLength": { + "type": "string", + "maxLength": 2, + "description": "This field contains the length of the BIN.\n" + }, + "accountPrefix": { + "type": "string", + "maxLength": 8, + "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 50, + "description": "This field contains the customer service phone number for the issuer.\n" + } + } + }, + "payoutInformation": { + "type": "object", + "properties": { + "pushFunds": { + "type": "object", + "properties": { + "moneyTransferFastFundsCrossBorder": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if cross-border money transfer OCTs (fast push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "moneyTransferFastFundsDomestic": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if domestic money transfer OCTs (fast push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "moneyTransferCrossBorder": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if cross-border money transfer OCTs (push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "moneyTransferDomestic": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if domestic money transfer OCTs (push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "nonMoneyTransferFastFundsCrossBorder": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if cross-border non-money transfer OCTs (fast push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "nonMoneyTransferFastFundsDomestic": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if domestic non-money transfer OCTs (fast push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "nonMoneyTransferCrossBorder": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if cross-border non-money transfer OCTs (push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "nonMoneyTransferDomestic": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if domestic non-money transfer OCTs (push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "onlineGamblingFastFundsCrossBorder": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if cross-border gambling OCTs (fast push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "onlineGamblingFastFundsDomestic": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if domestic gambling OCTs (fast push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "onlineGamblingCrossBorder": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if cross-border gambling OCTs (push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "onlineGamblingDomestic": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if domestic gambling OCTs (push funds) are allowed.\nPossible values:\n - `Y`\n - `N`\n" + }, + "domesticParticipant": { + "type": "string", + "maxLength": 5, + "description": "This field indicates if domestic OCTs (push funds) are allowed.\nNote: Supported only in US for domestic transactions involving Push Payments Gateway Service(PPGS).\nPossible values:\n - `true`\n - `false`\n" + }, + "crossBorderParticipant": { + "type": "string", + "maxLength": 5, + "description": "This field indicates if cross-border OCTs (push funds) are allowed.\nNote: Supported only in US for cross-border transactions involving Push Payments Gateway Service(PPGS).\nPossible values:\n - `true`\n - `false`\n" + } + } + }, + "pullFunds": { + "type": "object", + "properties": { + "domesticParticipant": { + "type": "string", + "maxLength": 5, + "description": "This field indicates if domestic AFTs (pull funds) are allowed.\nNote: Supported only in US for domestic transactions involving Push Payments Gateway Service(PPGS).\nPossible values:\n - `true`\n - `false`\n" + }, + "crossBorderParticipant": { + "type": "string", + "maxLength": 5, + "description": "This field indicates if cross-border AFTs (pull funds) are allowed.\nNote: Supported only in US for cross-border transactions involving Push Payments Gateway Service(PPGS).\nPossible values:\n - `true`\n - `false`\n" + } + } + }, + "geoRestrictionIndicator": { + "type": "string", + "maxLength": 1, + "description": "This field indicates if the recipient issuer can accept transactions from the originator country.\nPossible values:\n - `Y`\n - `N`\n" + } + } + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "title": "binLookupv400Response", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\n**Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.).\nThe `T` separates the date and the time. The `Z` indicates UTC.\n\nReturned by Cybersource for all services.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n" + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "BIN Lookup with Card", + "value": { + "clientReferenceInformation": { + "code": "TC50171_100" + }, + "paymentInformation": { + "card": { + "number": "4111111111111111" + } + } + } + }, + "example1": { + "summary": "BIN Lookup with Healthcare Card", + "value": { + "paymentInformation": { + "card": { + "number": "4288900100000" + } + } + } + }, + "example2": { + "summary": "BIN Lookup with Network Token", + "value": { + "paymentInformation": { + "card": { + "number": "4895370016313691" + } + } + } + }, + "example3": { + "summary": "BIN Lookup with TMS Customer ID", + "value": { + "paymentInformation": { + "customer": { + "id": "E5426CFDE77F7390E053A2598D0A925D" + } + } + } + }, + "example4": { + "summary": "BIN Lookup with TMS Payment Instrument", + "value": { + "paymentInformation": { + "paymentInstrument": { + "id": "E5427539180789D0E053A2598D0AF053" + } + } + } + }, + "example5": { + "summary": "BIN Lookup with TMS Instrument Identifier", + "value": { + "paymentInformation": { + "instrumentIdentifier": { + "id": "7010000000016241111" + } + } + } + }, + "example6": { + "summary": "BIN Lookup with TMS jti Transient Token", + "value": { + "tokenInformation": { + "jti": "1E0WC1GO87JG1BDP0CQ8SCR1TTK86U9N98H3WH8IFM9MVEWTIYFI62F4941E7A92" + } + } + }, + "example7": { + "summary": "BIN Lookup with TMS JWT Transient Token", + "value": { + "tokenInformation": { + "transientTokenJwt": "eyJraWQiOiIwODd0bk1DNU04bXJHR3JHMVJQTkwzZ2VyRUh5VWV1ciIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJGbGV4LzA4IiwiZXhwIjoxNjYwMTk1ODcwLCJ0eXBlIjoiYXBpLTAuMS4wIiwiaWF0IjoxNjYwMTk0OTcwLCJqdGkiOiIxRTBXQzFHTzg3SkcxQkRQMENROFNDUjFUVEs4NlU5Tjk4SDNXSDhJRk05TVZFV1RJWUZJNjJGNDk0MUU3QTkyIiwiY29udGVudCI6eyJwYXltZW50SW5mb3JtYXRpb24iOnsiY2FyZCI6eyJudW1iZXIiOnsibWFza2VkVmFsdWUiOiJYWFhYWFhYWFhYWFgxMTExIiwiYmluIjoiNDExMTExIn0sInR5cGUiOnsidmFsdWUiOiIwMDEifX19fX0.MkCLbyvufN4prGRvHJcqCu1WceDVlgubZVpShNWQVjpuFQUuqwrKg284sC7ucVKuIsOU0DTN8_OoxDLduvZhS7X_5TnO0QjyA_aFxbRBvU_bEz1l9V99VPADG89T-fox_L6sLUaoTJ8T4PyD7rkPHEA0nmXbqQCVqw4Czc5TqlKCwmL-Fe0NBR2HlOFI1PrSXT-7_wI-JTgXI0dQzb8Ub20erHwOLwu3oni4_ZmS3rGI_gxq2MHi8pO-ZOgA597be4WfVFAx1wnMbareqR72a0QM4DefeoltrpNqXSaASVyb5G0zuqg-BOjWJbawmg2QgcZ_vE3rJ6PDgWROvp9Tbw" + } + } + } + } + } + }, "/tss/v2/transactions/{id}": { "get": { "summary": "Retrieve a Transaction", @@ -73490,7 +74111,7 @@ "company": { "type": "string", "maxLength": 60, - "description": "Name of the customer's company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Name of the customer's company.\n" }, "country": { "type": "string", @@ -73528,7 +74149,7 @@ "taxAmount": { "type": "string", "maxLength": 15, - "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n1. You include each line item in your request.\n - 1st line item has `amount=10.00`, `quantity=1`, and `taxAmount=0.80`\n - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60`\n2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nThis field is frequently used for Level II and Level III transactions.\n\nFor details, see `tax_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n1. You include each line item in your request.\n - 1st line item has `amount=10.00`, `quantity=1`, and `taxAmount=0.80`\n - 2nd line item has `amount=20.00`, `quantity=1`, and `taxAmount=1.60`\n2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nThis field is frequently used for Level II and Level III transactions.\n" }, "quantity": { "type": "integer", @@ -73540,7 +74161,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n" }, "fulfillmentType": { "type": "string", @@ -73979,12 +74600,12 @@ "category": { "type": "string", "maxLength": 60, - "description": "Categorization of response message from processor\n\nPossible Values:\n- `APPROVED`\n- `ISSUER_WILL_NEVER_APPROVE`\n- `ISSUER_CANT_APPROVE_AT_THIS_TIME`\n- `ISSUER_CANT_APPROVE_WITH_THESE_DETAILS`\n- `GENERIC_ERROR`\n- `OTHERS`\n- `MATCH_NOT_FOUND`\n" + "description": "Categorization of response message from processor\n\nPossible Values:\n- `ISSUER_WILL_NEVER_APPROVE`\n- `ISSUER_CANNOT_APPROVE_AT_THIS_TIME`\n- `ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS`\n- `GENERIC_ERROR`\n- `PAYMENT_INSIGHTS_INTERNAL_ERROR`\n- `OTHERS`\n- `PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND`\n" }, "categoryCode": { "type": "string", "maxLength": 2, - "description": "Categorization Code of response message from processor\n\nPossible Values:\n- `01` : Issuer Will Never Approve\n- `02` : Issuer Can't Approve at this Time\n- `03` : Issuer Can't Approve with these Details\n- `04` : Generic Error\n- `98` : Others\n- `99` : Payment Insights Response Category Match Not Found\n" + "description": "Categorization Code of response message from processor\n\nPossible Values:\n- `01` : ISSUER_WILL_NEVER_APPROVE\n- `02` : ISSUER_CANNOT_APPROVE_AT_THIS_TIME\n- `03` : ISSUER_CANNOT_APPROVE_WITH_THESE_DETAILS\n- `04` : GENERIC_ERROR\n- `97` : PAYMENT_INSIGHTS_INTERNAL_ERROR\n- `98` : OTHERS\n- `99` : PAYMENT_INSIGHTS_RESPONSE_CATEGORY_MATCH_NOT_FOUND\n" }, "processorRawName": { "type": "string", @@ -73992,6 +74613,19 @@ "description": "Raw name of the processor used for the transaction processing, especially useful during acquirer swing to see\nwhich processor transaction settled with\n" } } + }, + "orchestration": { + "type": "object", + "properties": { + "infoCodes": { + "type": "array", + "items": { + "type": "string", + "maxLength": 60 + }, + "description": "Infocodes indicating which rules were triggered by the Service Orchestration product.\n" + } + } } } }, @@ -74075,7 +74709,7 @@ }, "credentialStoredOnFile": { "type": "string", - "description": "Indicates to the issuing bank two things:\n- The merchant has received consent from the cardholder to store their card details on file\n- The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder.\nThe purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions.\n\nValid values:\n- `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `N` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n\nFor details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n" + "description": "Indicates to the issuing bank two things:\n- The merchant has received consent from the cardholder to store their card details on file\n- The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder.\nThe purpose of the merchant-initiated transaction is to ensure that the cardholder's credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant's file for future transactions.\n\nValid values:\n- `Y` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `N` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n" }, "storedCredentialUsed": { "type": "string", @@ -74088,7 +74722,7 @@ "reason": { "type": "string", "maxLength": 1, - "description": "Reason for the merchant-initiated transaction or incremental authorization. Possible values:\n- `1`: Resubmission\n- `2`: Delayed charge\n- `3`: Reauthorization for split shipment\n- `4`: No show\n- `5`: Account top up\nThis field is required only for the five kinds of transactions in the preceding list.\nThis field is supported only for merchant-initiated transactions and incremental authorizations.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 160-163\n- Field: Message Reason Code\n\n#### All Processors\nFor details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n" + "description": "Reason for the merchant-initiated transaction or incremental authorization. Possible values:\n- `1`: Resubmission\n- `2`: Delayed charge\n- `3`: Reauthorization for split shipment\n- `4`: No show\n- `5`: Account top up\nThis field is required only for the five kinds of transactions in the preceding list.\nThis field is supported only for merchant-initiated transactions and incremental authorizations.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 160-163\n- Field: Message Reason Code\n" }, "previousTransactionId": { "type": "string", @@ -74098,7 +74732,7 @@ "originalAuthorizedAmount": { "type": "string", "maxLength": 61, - "description": "Amount of the original authorization.\n\nThis field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech.\n\nSee \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization\nUsing the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "description": "Amount of the original authorization.\n\nThis field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech.\n" }, "agreementId": { "type": "string", @@ -74211,7 +74845,7 @@ "transactionId": { "type": "string", "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" + "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n\nReturned by the authorization service.\n\n#### PIN debit\nTransaction identifier generated by the processor.\n\nReturned by PIN debit credit.\n\n#### GPX\nProcessor transaction ID.\n\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"processorInformation.networkTransactionId\" in [REST API Fields](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n\n#### Moneris\nThis value identifies the transaction on a host system. It contains the following information:\n- Terminal used to process the transaction\n- Shift during which the transaction took place\n- Batch number\n- Transaction number within the batch\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\n**Example** For the value\n66012345001069003:\n- Terminal ID = 66012345\n- Shift number = 001\n- Batch number = 069\n- Transaction number = 003\n" }, "networkTransactionId": { "type": "string", @@ -75710,7 +76344,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "businessApplicationId": { "type": "string", @@ -75804,7 +76438,7 @@ "hash": { "type": "string", "maxLength": 255, - "description": "The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field.\n\nNOTE: For details about the value of this field, see the `decision_provider_#_field_#_value` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n\nFor more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link).\n" + "description": "The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field.\nFor more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link).\n" }, "smartId": { "type": "string", @@ -76551,7 +77185,7 @@ "paymentSolution": { "type": "string", "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. \n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n - `013`: Cybersource P2PE Decryption\n - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.\n - `027`: Click to Pay.\n" }, "businessApplicationId": { "type": "string", @@ -76645,7 +77279,7 @@ "hash": { "type": "string", "maxLength": 255, - "description": "The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field.\n\nNOTE: For details about the value of this field, see the `decision_provider_#_field_#_value` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n\nFor more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link).\n" + "description": "The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field.\nFor more details about this field, see the `device_fingerprint_hash` field description in the _Device Fingerprinting Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Device Fingerprinting Guide_ (PDF link).\n" }, "smartId": { "type": "string", @@ -83877,7 +84511,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -83887,7 +84521,7 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" } } }, @@ -83902,7 +84536,7 @@ }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "taxRate": { "description": "Shipping Tax rate applied to the freight amount.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n", @@ -83940,7 +84574,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "discountAmount": { "type": "string", @@ -83960,7 +84594,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "totalAmount": { "type": "string", @@ -84214,7 +84848,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -84224,7 +84858,7 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" } } }, @@ -84239,7 +84873,7 @@ }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "taxRate": { "description": "Shipping Tax rate applied to the freight amount.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n", @@ -84277,7 +84911,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "discountAmount": { "type": "string", @@ -84297,7 +84931,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "totalAmount": { "type": "string", @@ -85555,7 +86189,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -85565,7 +86199,7 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" } } }, @@ -85580,7 +86214,7 @@ }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "taxRate": { "description": "Shipping Tax rate applied to the freight amount.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n", @@ -85618,7 +86252,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "discountAmount": { "type": "string", @@ -85638,7 +86272,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "totalAmount": { "type": "string", @@ -85953,7 +86587,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -85963,7 +86597,7 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" } } }, @@ -85978,7 +86612,7 @@ }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "taxRate": { "description": "Shipping Tax rate applied to the freight amount.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n", @@ -86016,7 +86650,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "discountAmount": { "type": "string", @@ -86036,7 +86670,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "totalAmount": { "type": "string", @@ -86289,7 +86923,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -86299,7 +86933,7 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" } } }, @@ -86314,7 +86948,7 @@ }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "taxRate": { "description": "Shipping Tax rate applied to the freight amount.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n", @@ -86352,7 +86986,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "discountAmount": { "type": "string", @@ -86372,7 +87006,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "totalAmount": { "type": "string", @@ -86879,7 +87513,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -86889,7 +87523,7 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" } } }, @@ -86904,7 +87538,7 @@ }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "taxRate": { "description": "Shipping Tax rate applied to the freight amount.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n", @@ -86942,7 +87576,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "discountAmount": { "type": "string", @@ -86962,7 +87596,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "totalAmount": { "type": "string", @@ -87416,7 +88050,7 @@ "properties": { "type": { "type": "string", - "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n\nFor processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field\ndescriptions in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Indicates the type of tax data for the _taxDetails_ object.\n\nPossible values:\n\n- `alternate`\n- `local`\n- `national`\n- `vat`\n- `other`\n- `green`\n" }, "amount": { "type": "string", @@ -87426,7 +88060,7 @@ "rate": { "type": "string", "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n\nFor processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n" + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" } } }, @@ -87441,7 +88075,7 @@ }, "taxable": { "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nFor processor-specific information, see the `tax_indicator` field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n" + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include\n`invoiceDetails.taxable` in the data it sends to the processor.\n\nPossible values:\n - **true**\n - **false**\n" }, "taxRate": { "description": "Shipping Tax rate applied to the freight amount.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n", @@ -87479,7 +88113,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "discountAmount": { "type": "string", @@ -87499,7 +88133,7 @@ "taxRate": { "type": "string", "maxLength": 7, - "description": "Tax rate applied to the item.\n\nFor details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + "description": "Tax rate applied to the item.\n\n**Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\n**Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" }, "totalAmount": { "type": "string", @@ -88902,7 +89536,7 @@ "productCode": { "type": "string", "maxLength": 255, - "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/).\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" + "description": "Type of product. The value for this field is used to identify the product category (electronic, handling, physical,\nservice, or shipping). The default value is `default`.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set\nthis field to a value other than `default` or one of the values related to shipping and/or handling, then\n`orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and\n`orderInformation.lineItems[].productSku` fields are required.\n\nOptional field.\n\n#### Tax Calculation\nOptional field for U.S., Canadian, international tax, and value added taxes.\n\nThe Product Codes for the tax service are located in the Cybersource Tax Codes guide. Contact Customer Support to request the guide. If you don't send a tax service Product Code in your tax request, product-based rules or exemptions will not be applied and the transaction will default to fully taxable in the locations where you've indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].\n" }, "quantity": { "type": "integer", @@ -88919,7 +89553,7 @@ "unitPrice": { "type": "string", "maxLength": 15, - "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/)\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" + "description": "Per-item price of the product. This value for this field cannot be negative.\n\nYou must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\nYou can include a decimal point (.), but you cannot include any other special characters.\nThe value is truncated to the correct number of decimal places.\n\n#### DCC with a Third-Party Provider\nSet this field to the converted amount that was returned by the DCC provider. You must include either\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request.\n\n#### Tax Calculation\nRequired field for U.S., Canadian, international and value added taxes.\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen.\n\n#### Maximum Field Lengths\nFor GPN and JCN Gateway: Decimal (10)\nAll other processors: Decimal (15)\n" }, "taxAmount": { "type": "string", @@ -89006,7 +89640,7 @@ "sellerVatRegistrationNumber": { "type": "string", "maxLength": 25, - "description": "VAT seller registration number.\n\nFor details, see \"International Taxes and Value-Added Tax (VAT)\" in [Tax Calculation Service Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/Tax_SCMP_API/html/).\n\n**NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object.\n\n#### Tax Calculation\nOptional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" + "description": "VAT seller registration number.\n\n**NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object.\n\n#### Tax Calculation\nOptional field for international and value added taxes only. Not applicable to U.S. and Canadian taxes.\n" } } } @@ -89081,7 +89715,7 @@ "vatRegistrationNumber": { "type": "string", "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the `merchant_vat_registration_number` field description in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + "description": "Your government-assigned tax identification number.\n\n#### Tax Calculation\nRequired field for value added tax only. Not applicable to U.S. and Canadian taxes.\n\n#### CyberSource through VisaNet\nFor CtV processors, the maximum length is 20.\n" } } }, @@ -110580,7 +111214,7 @@ "Unified Checkout Capture Context" ], "summary": "Generate Unified Checkout Capture Context", - "description": "Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions.\nClick to Pay Drop-in UI is built on the Unified Checkout platform.\nFor more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java). For more information about Click to Pay drop in UI, see the [Click to Pay Drop-in UI Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/click-to-pay/developer/all/rest/click-to-pay/ctp-intro.html).\nGenerate Unified Checkout Capture Context\nGenerate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page", + "description": "Unified Checkout is a powerful product within the Digital Acceptance Suite. Unified Checkout is designed to assist merchants with the adoption and inclusion of digital payments within their payment acceptance page. With Unified Checkout Integration you can add digital payment methods to create familiar, convenient and seamless payment experiences that are designed to reduce checkout friction and increase conversions.\nClick to Pay Drop-in UI is built on the Unified Checkout platform.\nFor more information about Unified Checkout, see the [Unified Checkout Developer Guides Page](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-intro.html). For examples on how to integrate Unified Checkout within your webpage please see our [GitHub Unified Checkout Samples](https://github.com/CyberSource/cybersource-unified-checkout-sample-java).\nGenerate Unified Checkout Capture Context\nGenerate a one-time use capture context used for the invocation of Unified Checkout. The Request wil contain all of the parameters for how Unified Checkout will operate within a client webpage. The resulting payload will be a JWT signed object that can be used to initiate Unified Checkout or Click to Pay Drop-in UI within a web page", "operationId": "generateUnifiedCheckoutCaptureContext", "x-devcenter-metaData": { "categoryTag": "Unified_Checkout", diff --git a/test/test_bin_lookup_api.py b/test/test_bin_lookup_api.py new file mode 100644 index 00000000..56f40a9e --- /dev/null +++ b/test/test_bin_lookup_api.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.apis.bin_lookup_api import BinLookupApi + + +class TestBinLookupApi(unittest.TestCase): + """ BinLookupApi unit test stubs """ + + def setUp(self): + self.api = CyberSource.apis.bin_lookup_api.BinLookupApi() + + def tearDown(self): + pass + + def test_get_account_info(self): + """ + Test case for get_account_info + + BIN Lookup API + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_setups.py b/test/test_bin_lookupv400_response.py similarity index 65% rename from test/test_inline_response2011_setups.py rename to test/test_bin_lookupv400_response.py index 33f7b53e..23779b60 100644 --- a/test/test_inline_response2011_setups.py +++ b/test/test_bin_lookupv400_response.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_setups import InlineResponse2011Setups +from CyberSource.models.bin_lookupv400_response import BinLookupv400Response -class TestInlineResponse2011Setups(unittest.TestCase): - """ InlineResponse2011Setups unit test stubs """ +class TestBinLookupv400Response(unittest.TestCase): + """ BinLookupv400Response unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011Setups(self): + def testBinLookupv400Response(self): """ - Test InlineResponse2011Setups + Test BinLookupv400Response """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_setups.InlineResponse2011Setups() + #model = CyberSource.models.bin_lookupv400_response.BinLookupv400Response() pass diff --git a/test/test_inline_response2011_integration_information.py b/test/test_binv1binlookup_client_reference_information.py similarity index 58% rename from test/test_inline_response2011_integration_information.py rename to test/test_binv1binlookup_client_reference_information.py index fdd38e33..3775e306 100644 --- a/test/test_inline_response2011_integration_information.py +++ b/test/test_binv1binlookup_client_reference_information.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_integration_information import InlineResponse2011IntegrationInformation +from CyberSource.models.binv1binlookup_client_reference_information import Binv1binlookupClientReferenceInformation -class TestInlineResponse2011IntegrationInformation(unittest.TestCase): - """ InlineResponse2011IntegrationInformation unit test stubs """ +class TestBinv1binlookupClientReferenceInformation(unittest.TestCase): + """ Binv1binlookupClientReferenceInformation unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011IntegrationInformation(self): + def testBinv1binlookupClientReferenceInformation(self): """ - Test InlineResponse2011IntegrationInformation + Test Binv1binlookupClientReferenceInformation """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_integration_information.InlineResponse2011IntegrationInformation() + #model = CyberSource.models.binv1binlookup_client_reference_information.Binv1binlookupClientReferenceInformation() pass diff --git a/test/test_inline_response2012_key_information.py b/test/test_binv1binlookup_payment_information.py similarity index 61% rename from test/test_inline_response2012_key_information.py rename to test/test_binv1binlookup_payment_information.py index 01b1131a..63e91748 100644 --- a/test/test_inline_response2012_key_information.py +++ b/test/test_binv1binlookup_payment_information.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2012_key_information import InlineResponse2012KeyInformation +from CyberSource.models.binv1binlookup_payment_information import Binv1binlookupPaymentInformation -class TestInlineResponse2012KeyInformation(unittest.TestCase): - """ InlineResponse2012KeyInformation unit test stubs """ +class TestBinv1binlookupPaymentInformation(unittest.TestCase): + """ Binv1binlookupPaymentInformation unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2012KeyInformation(self): + def testBinv1binlookupPaymentInformation(self): """ - Test InlineResponse2012KeyInformation + Test Binv1binlookupPaymentInformation """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2012_key_information.InlineResponse2012KeyInformation() + #model = CyberSource.models.binv1binlookup_payment_information.Binv1binlookupPaymentInformation() pass diff --git a/test/test_binv1binlookup_payment_information_card.py b/test/test_binv1binlookup_payment_information_card.py new file mode 100644 index 00000000..0ec54218 --- /dev/null +++ b/test/test_binv1binlookup_payment_information_card.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.binv1binlookup_payment_information_card import Binv1binlookupPaymentInformationCard + + +class TestBinv1binlookupPaymentInformationCard(unittest.TestCase): + """ Binv1binlookupPaymentInformationCard unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBinv1binlookupPaymentInformationCard(self): + """ + Test Binv1binlookupPaymentInformationCard + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.binv1binlookup_payment_information_card.Binv1binlookupPaymentInformationCard() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_binv1binlookup_processing_information.py b/test/test_binv1binlookup_processing_information.py new file mode 100644 index 00000000..7d2ccd4e --- /dev/null +++ b/test/test_binv1binlookup_processing_information.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.binv1binlookup_processing_information import Binv1binlookupProcessingInformation + + +class TestBinv1binlookupProcessingInformation(unittest.TestCase): + """ Binv1binlookupProcessingInformation unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBinv1binlookupProcessingInformation(self): + """ + Test Binv1binlookupProcessingInformation + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.binv1binlookup_processing_information.Binv1binlookupProcessingInformation() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_binv1binlookup_processing_information_payout_options.py b/test/test_binv1binlookup_processing_information_payout_options.py new file mode 100644 index 00000000..f977db46 --- /dev/null +++ b/test/test_binv1binlookup_processing_information_payout_options.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.binv1binlookup_processing_information_payout_options import Binv1binlookupProcessingInformationPayoutOptions + + +class TestBinv1binlookupProcessingInformationPayoutOptions(unittest.TestCase): + """ Binv1binlookupProcessingInformationPayoutOptions unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testBinv1binlookupProcessingInformationPayoutOptions(self): + """ + Test Binv1binlookupProcessingInformationPayoutOptions + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.binv1binlookup_processing_information_payout_options.Binv1binlookupProcessingInformationPayoutOptions() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_setups_payments.py b/test/test_binv1binlookup_token_information.py similarity index 61% rename from test/test_inline_response2011_setups_payments.py rename to test/test_binv1binlookup_token_information.py index 2fd37433..65ffa937 100644 --- a/test/test_inline_response2011_setups_payments.py +++ b/test/test_binv1binlookup_token_information.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_setups_payments import InlineResponse2011SetupsPayments +from CyberSource.models.binv1binlookup_token_information import Binv1binlookupTokenInformation -class TestInlineResponse2011SetupsPayments(unittest.TestCase): - """ InlineResponse2011SetupsPayments unit test stubs """ +class TestBinv1binlookupTokenInformation(unittest.TestCase): + """ Binv1binlookupTokenInformation unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011SetupsPayments(self): + def testBinv1binlookupTokenInformation(self): """ - Test InlineResponse2011SetupsPayments + Test Binv1binlookupTokenInformation """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_setups_payments.InlineResponse2011SetupsPayments() + #model = CyberSource.models.binv1binlookup_token_information.Binv1binlookupTokenInformation() pass diff --git a/test/test_inline_response2011_setups_risk.py b/test/test_create_bin_lookup_request.py similarity index 63% rename from test/test_inline_response2011_setups_risk.py rename to test/test_create_bin_lookup_request.py index 86983107..a6e7e014 100644 --- a/test/test_inline_response2011_setups_risk.py +++ b/test/test_create_bin_lookup_request.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_setups_risk import InlineResponse2011SetupsRisk +from CyberSource.models.create_bin_lookup_request import CreateBinLookupRequest -class TestInlineResponse2011SetupsRisk(unittest.TestCase): - """ InlineResponse2011SetupsRisk unit test stubs """ +class TestCreateBinLookupRequest(unittest.TestCase): + """ CreateBinLookupRequest unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011SetupsRisk(self): + def testCreateBinLookupRequest(self): """ - Test InlineResponse2011SetupsRisk + Test CreateBinLookupRequest """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_setups_risk.InlineResponse2011SetupsRisk() + #model = CyberSource.models.create_bin_lookup_request.CreateBinLookupRequest() pass diff --git a/test/test_inline_response2011_issuer_information.py b/test/test_inline_response2011_issuer_information.py new file mode 100644 index 00000000..b3256cff --- /dev/null +++ b/test/test_inline_response2011_issuer_information.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2011_issuer_information import InlineResponse2011IssuerInformation + + +class TestInlineResponse2011IssuerInformation(unittest.TestCase): + """ InlineResponse2011IssuerInformation unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2011IssuerInformation(self): + """ + Test InlineResponse2011IssuerInformation + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2011_issuer_information.InlineResponse2011IssuerInformation() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_payment_account_information.py b/test/test_inline_response2011_payment_account_information.py new file mode 100644 index 00000000..e118f711 --- /dev/null +++ b/test/test_inline_response2011_payment_account_information.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2011_payment_account_information import InlineResponse2011PaymentAccountInformation + + +class TestInlineResponse2011PaymentAccountInformation(unittest.TestCase): + """ InlineResponse2011PaymentAccountInformation unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2011PaymentAccountInformation(self): + """ + Test InlineResponse2011PaymentAccountInformation + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2011_payment_account_information.InlineResponse2011PaymentAccountInformation() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_payment_account_information_card.py b/test/test_inline_response2011_payment_account_information_card.py new file mode 100644 index 00000000..82642ace --- /dev/null +++ b/test/test_inline_response2011_payment_account_information_card.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2011_payment_account_information_card import InlineResponse2011PaymentAccountInformationCard + + +class TestInlineResponse2011PaymentAccountInformationCard(unittest.TestCase): + """ InlineResponse2011PaymentAccountInformationCard unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2011PaymentAccountInformationCard(self): + """ + Test InlineResponse2011PaymentAccountInformationCard + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2011_payment_account_information_card.InlineResponse2011PaymentAccountInformationCard() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_payment_account_information_card_brands.py b/test/test_inline_response2011_payment_account_information_card_brands.py new file mode 100644 index 00000000..f782fb8d --- /dev/null +++ b/test/test_inline_response2011_payment_account_information_card_brands.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2011_payment_account_information_card_brands import InlineResponse2011PaymentAccountInformationCardBrands + + +class TestInlineResponse2011PaymentAccountInformationCardBrands(unittest.TestCase): + """ InlineResponse2011PaymentAccountInformationCardBrands unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2011PaymentAccountInformationCardBrands(self): + """ + Test InlineResponse2011PaymentAccountInformationCardBrands + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2011_payment_account_information_card_brands.InlineResponse2011PaymentAccountInformationCardBrands() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_payment_account_information_features.py b/test/test_inline_response2011_payment_account_information_features.py new file mode 100644 index 00000000..22a81895 --- /dev/null +++ b/test/test_inline_response2011_payment_account_information_features.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2011_payment_account_information_features import InlineResponse2011PaymentAccountInformationFeatures + + +class TestInlineResponse2011PaymentAccountInformationFeatures(unittest.TestCase): + """ InlineResponse2011PaymentAccountInformationFeatures unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2011PaymentAccountInformationFeatures(self): + """ + Test InlineResponse2011PaymentAccountInformationFeatures + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2011_payment_account_information_features.InlineResponse2011PaymentAccountInformationFeatures() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_payment_account_information_network.py b/test/test_inline_response2011_payment_account_information_network.py new file mode 100644 index 00000000..979cb887 --- /dev/null +++ b/test/test_inline_response2011_payment_account_information_network.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2011_payment_account_information_network import InlineResponse2011PaymentAccountInformationNetwork + + +class TestInlineResponse2011PaymentAccountInformationNetwork(unittest.TestCase): + """ InlineResponse2011PaymentAccountInformationNetwork unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2011PaymentAccountInformationNetwork(self): + """ + Test InlineResponse2011PaymentAccountInformationNetwork + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2011_payment_account_information_network.InlineResponse2011PaymentAccountInformationNetwork() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_payout_information.py b/test/test_inline_response2011_payout_information.py new file mode 100644 index 00000000..f57bf7f2 --- /dev/null +++ b/test/test_inline_response2011_payout_information.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2011_payout_information import InlineResponse2011PayoutInformation + + +class TestInlineResponse2011PayoutInformation(unittest.TestCase): + """ InlineResponse2011PayoutInformation unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2011PayoutInformation(self): + """ + Test InlineResponse2011PayoutInformation + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2011_payout_information.InlineResponse2011PayoutInformation() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_payout_information_pull_funds.py b/test/test_inline_response2011_payout_information_pull_funds.py new file mode 100644 index 00000000..bff7aad4 --- /dev/null +++ b/test/test_inline_response2011_payout_information_pull_funds.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2011_payout_information_pull_funds import InlineResponse2011PayoutInformationPullFunds + + +class TestInlineResponse2011PayoutInformationPullFunds(unittest.TestCase): + """ InlineResponse2011PayoutInformationPullFunds unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2011PayoutInformationPullFunds(self): + """ + Test InlineResponse2011PayoutInformationPullFunds + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2011_payout_information_pull_funds.InlineResponse2011PayoutInformationPullFunds() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_payout_information_push_funds.py b/test/test_inline_response2011_payout_information_push_funds.py new file mode 100644 index 00000000..e496a81f --- /dev/null +++ b/test/test_inline_response2011_payout_information_push_funds.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2011_payout_information_push_funds import InlineResponse2011PayoutInformationPushFunds + + +class TestInlineResponse2011PayoutInformationPushFunds(unittest.TestCase): + """ InlineResponse2011PayoutInformationPushFunds unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2011PayoutInformationPushFunds(self): + """ + Test InlineResponse2011PayoutInformationPushFunds + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2011_payout_information_push_funds.InlineResponse2011PayoutInformationPushFunds() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2012_integration_information.py b/test/test_inline_response2012_integration_information.py new file mode 100644 index 00000000..e61dbf95 --- /dev/null +++ b/test/test_inline_response2012_integration_information.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2012_integration_information import InlineResponse2012IntegrationInformation + + +class TestInlineResponse2012IntegrationInformation(unittest.TestCase): + """ InlineResponse2012IntegrationInformation unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2012IntegrationInformation(self): + """ + Test InlineResponse2012IntegrationInformation + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2012_integration_information.InlineResponse2012IntegrationInformation() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_integration_information_tenant_configurations.py b/test/test_inline_response2012_integration_information_tenant_configurations.py similarity index 61% rename from test/test_inline_response2011_integration_information_tenant_configurations.py rename to test/test_inline_response2012_integration_information_tenant_configurations.py index 86b8372e..9a7c6205 100644 --- a/test/test_inline_response2011_integration_information_tenant_configurations.py +++ b/test/test_inline_response2012_integration_information_tenant_configurations.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_integration_information_tenant_configurations import InlineResponse2011IntegrationInformationTenantConfigurations +from CyberSource.models.inline_response2012_integration_information_tenant_configurations import InlineResponse2012IntegrationInformationTenantConfigurations -class TestInlineResponse2011IntegrationInformationTenantConfigurations(unittest.TestCase): - """ InlineResponse2011IntegrationInformationTenantConfigurations unit test stubs """ +class TestInlineResponse2012IntegrationInformationTenantConfigurations(unittest.TestCase): + """ InlineResponse2012IntegrationInformationTenantConfigurations unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011IntegrationInformationTenantConfigurations(self): + def testInlineResponse2012IntegrationInformationTenantConfigurations(self): """ - Test InlineResponse2011IntegrationInformationTenantConfigurations + Test InlineResponse2012IntegrationInformationTenantConfigurations """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_integration_information_tenant_configurations.InlineResponse2011IntegrationInformationTenantConfigurations() + #model = CyberSource.models.inline_response2012_integration_information_tenant_configurations.InlineResponse2012IntegrationInformationTenantConfigurations() pass diff --git a/test/test_inline_response2011_registration_information.py b/test/test_inline_response2012_organization_information.py similarity index 58% rename from test/test_inline_response2011_registration_information.py rename to test/test_inline_response2012_organization_information.py index 4ffb5f26..1425a472 100644 --- a/test/test_inline_response2011_registration_information.py +++ b/test/test_inline_response2012_organization_information.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_registration_information import InlineResponse2011RegistrationInformation +from CyberSource.models.inline_response2012_organization_information import InlineResponse2012OrganizationInformation -class TestInlineResponse2011RegistrationInformation(unittest.TestCase): - """ InlineResponse2011RegistrationInformation unit test stubs """ +class TestInlineResponse2012OrganizationInformation(unittest.TestCase): + """ InlineResponse2012OrganizationInformation unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011RegistrationInformation(self): + def testInlineResponse2012OrganizationInformation(self): """ - Test InlineResponse2011RegistrationInformation + Test InlineResponse2012OrganizationInformation """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_registration_information.InlineResponse2011RegistrationInformation() + #model = CyberSource.models.inline_response2012_organization_information.InlineResponse2012OrganizationInformation() pass diff --git a/test/test_inline_response2011_product_information_setups.py b/test/test_inline_response2012_product_information_setups.py similarity index 58% rename from test/test_inline_response2011_product_information_setups.py rename to test/test_inline_response2012_product_information_setups.py index 4961d8ba..3fe573b5 100644 --- a/test/test_inline_response2011_product_information_setups.py +++ b/test/test_inline_response2012_product_information_setups.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_product_information_setups import InlineResponse2011ProductInformationSetups +from CyberSource.models.inline_response2012_product_information_setups import InlineResponse2012ProductInformationSetups -class TestInlineResponse2011ProductInformationSetups(unittest.TestCase): - """ InlineResponse2011ProductInformationSetups unit test stubs """ +class TestInlineResponse2012ProductInformationSetups(unittest.TestCase): + """ InlineResponse2012ProductInformationSetups unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011ProductInformationSetups(self): + def testInlineResponse2012ProductInformationSetups(self): """ - Test InlineResponse2011ProductInformationSetups + Test InlineResponse2012ProductInformationSetups """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_product_information_setups.InlineResponse2011ProductInformationSetups() + #model = CyberSource.models.inline_response2012_product_information_setups.InlineResponse2012ProductInformationSetups() pass diff --git a/test/test_inline_response2011_organization_information.py b/test/test_inline_response2012_registration_information.py similarity index 58% rename from test/test_inline_response2011_organization_information.py rename to test/test_inline_response2012_registration_information.py index 35ba5a84..b5076352 100644 --- a/test/test_inline_response2011_organization_information.py +++ b/test/test_inline_response2012_registration_information.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_organization_information import InlineResponse2011OrganizationInformation +from CyberSource.models.inline_response2012_registration_information import InlineResponse2012RegistrationInformation -class TestInlineResponse2011OrganizationInformation(unittest.TestCase): - """ InlineResponse2011OrganizationInformation unit test stubs """ +class TestInlineResponse2012RegistrationInformation(unittest.TestCase): + """ InlineResponse2012RegistrationInformation unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011OrganizationInformation(self): + def testInlineResponse2012RegistrationInformation(self): """ - Test InlineResponse2011OrganizationInformation + Test InlineResponse2012RegistrationInformation """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_organization_information.InlineResponse2011OrganizationInformation() + #model = CyberSource.models.inline_response2012_registration_information.InlineResponse2012RegistrationInformation() pass diff --git a/test/test_inline_response2012_setups.py b/test/test_inline_response2012_setups.py new file mode 100644 index 00000000..53e4eff8 --- /dev/null +++ b/test/test_inline_response2012_setups.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2012_setups import InlineResponse2012Setups + + +class TestInlineResponse2012Setups(unittest.TestCase): + """ InlineResponse2012Setups unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2012Setups(self): + """ + Test InlineResponse2012Setups + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2012_setups.InlineResponse2012Setups() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_setups_commerce_solutions.py b/test/test_inline_response2012_setups_commerce_solutions.py similarity index 58% rename from test/test_inline_response2011_setups_commerce_solutions.py rename to test/test_inline_response2012_setups_commerce_solutions.py index 12e7d014..cdf5e040 100644 --- a/test/test_inline_response2011_setups_commerce_solutions.py +++ b/test/test_inline_response2012_setups_commerce_solutions.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_setups_commerce_solutions import InlineResponse2011SetupsCommerceSolutions +from CyberSource.models.inline_response2012_setups_commerce_solutions import InlineResponse2012SetupsCommerceSolutions -class TestInlineResponse2011SetupsCommerceSolutions(unittest.TestCase): - """ InlineResponse2011SetupsCommerceSolutions unit test stubs """ +class TestInlineResponse2012SetupsCommerceSolutions(unittest.TestCase): + """ InlineResponse2012SetupsCommerceSolutions unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011SetupsCommerceSolutions(self): + def testInlineResponse2012SetupsCommerceSolutions(self): """ - Test InlineResponse2011SetupsCommerceSolutions + Test InlineResponse2012SetupsCommerceSolutions """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_setups_commerce_solutions.InlineResponse2011SetupsCommerceSolutions() + #model = CyberSource.models.inline_response2012_setups_commerce_solutions.InlineResponse2012SetupsCommerceSolutions() pass diff --git a/test/test_inline_response2012_setups_payments.py b/test/test_inline_response2012_setups_payments.py new file mode 100644 index 00000000..2e3153da --- /dev/null +++ b/test/test_inline_response2012_setups_payments.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2012_setups_payments import InlineResponse2012SetupsPayments + + +class TestInlineResponse2012SetupsPayments(unittest.TestCase): + """ InlineResponse2012SetupsPayments unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2012SetupsPayments(self): + """ + Test InlineResponse2012SetupsPayments + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2012_setups_payments.InlineResponse2012SetupsPayments() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_setups_payments_card_processing.py b/test/test_inline_response2012_setups_payments_card_processing.py similarity index 58% rename from test/test_inline_response2011_setups_payments_card_processing.py rename to test/test_inline_response2012_setups_payments_card_processing.py index 93d5c600..55236a63 100644 --- a/test/test_inline_response2011_setups_payments_card_processing.py +++ b/test/test_inline_response2012_setups_payments_card_processing.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_setups_payments_card_processing import InlineResponse2011SetupsPaymentsCardProcessing +from CyberSource.models.inline_response2012_setups_payments_card_processing import InlineResponse2012SetupsPaymentsCardProcessing -class TestInlineResponse2011SetupsPaymentsCardProcessing(unittest.TestCase): - """ InlineResponse2011SetupsPaymentsCardProcessing unit test stubs """ +class TestInlineResponse2012SetupsPaymentsCardProcessing(unittest.TestCase): + """ InlineResponse2012SetupsPaymentsCardProcessing unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011SetupsPaymentsCardProcessing(self): + def testInlineResponse2012SetupsPaymentsCardProcessing(self): """ - Test InlineResponse2011SetupsPaymentsCardProcessing + Test InlineResponse2012SetupsPaymentsCardProcessing """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_setups_payments_card_processing.InlineResponse2011SetupsPaymentsCardProcessing() + #model = CyberSource.models.inline_response2012_setups_payments_card_processing.InlineResponse2012SetupsPaymentsCardProcessing() pass diff --git a/test/test_inline_response2011_setups_payments_card_processing_configuration_status.py b/test/test_inline_response2012_setups_payments_card_processing_configuration_status.py similarity index 62% rename from test/test_inline_response2011_setups_payments_card_processing_configuration_status.py rename to test/test_inline_response2012_setups_payments_card_processing_configuration_status.py index e1b52e2c..2801d8bb 100644 --- a/test/test_inline_response2011_setups_payments_card_processing_configuration_status.py +++ b/test/test_inline_response2012_setups_payments_card_processing_configuration_status.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_setups_payments_card_processing_configuration_status import InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus +from CyberSource.models.inline_response2012_setups_payments_card_processing_configuration_status import InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus -class TestInlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus(unittest.TestCase): - """ InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus unit test stubs """ +class TestInlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus(unittest.TestCase): + """ InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus(self): + def testInlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus(self): """ - Test InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus + Test InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_setups_payments_card_processing_configuration_status.InlineResponse2011SetupsPaymentsCardProcessingConfigurationStatus() + #model = CyberSource.models.inline_response2012_setups_payments_card_processing_configuration_status.InlineResponse2012SetupsPaymentsCardProcessingConfigurationStatus() pass diff --git a/test/test_inline_response2011_setups_payments_card_processing_subscription_status.py b/test/test_inline_response2012_setups_payments_card_processing_subscription_status.py similarity index 62% rename from test/test_inline_response2011_setups_payments_card_processing_subscription_status.py rename to test/test_inline_response2012_setups_payments_card_processing_subscription_status.py index f7bbd8f5..3d3af751 100644 --- a/test/test_inline_response2011_setups_payments_card_processing_subscription_status.py +++ b/test/test_inline_response2012_setups_payments_card_processing_subscription_status.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_setups_payments_card_processing_subscription_status import InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus +from CyberSource.models.inline_response2012_setups_payments_card_processing_subscription_status import InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus -class TestInlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus(unittest.TestCase): - """ InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus unit test stubs """ +class TestInlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus(unittest.TestCase): + """ InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus(self): + def testInlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus(self): """ - Test InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus + Test InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_setups_payments_card_processing_subscription_status.InlineResponse2011SetupsPaymentsCardProcessingSubscriptionStatus() + #model = CyberSource.models.inline_response2012_setups_payments_card_processing_subscription_status.InlineResponse2012SetupsPaymentsCardProcessingSubscriptionStatus() pass diff --git a/test/test_inline_response2011_setups_payments_digital_payments.py b/test/test_inline_response2012_setups_payments_digital_payments.py similarity index 58% rename from test/test_inline_response2011_setups_payments_digital_payments.py rename to test/test_inline_response2012_setups_payments_digital_payments.py index d5090d36..8001ba65 100644 --- a/test/test_inline_response2011_setups_payments_digital_payments.py +++ b/test/test_inline_response2012_setups_payments_digital_payments.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_setups_payments_digital_payments import InlineResponse2011SetupsPaymentsDigitalPayments +from CyberSource.models.inline_response2012_setups_payments_digital_payments import InlineResponse2012SetupsPaymentsDigitalPayments -class TestInlineResponse2011SetupsPaymentsDigitalPayments(unittest.TestCase): - """ InlineResponse2011SetupsPaymentsDigitalPayments unit test stubs """ +class TestInlineResponse2012SetupsPaymentsDigitalPayments(unittest.TestCase): + """ InlineResponse2012SetupsPaymentsDigitalPayments unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011SetupsPaymentsDigitalPayments(self): + def testInlineResponse2012SetupsPaymentsDigitalPayments(self): """ - Test InlineResponse2011SetupsPaymentsDigitalPayments + Test InlineResponse2012SetupsPaymentsDigitalPayments """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_setups_payments_digital_payments.InlineResponse2011SetupsPaymentsDigitalPayments() + #model = CyberSource.models.inline_response2012_setups_payments_digital_payments.InlineResponse2012SetupsPaymentsDigitalPayments() pass diff --git a/test/test_inline_response2012_setups_risk.py b/test/test_inline_response2012_setups_risk.py new file mode 100644 index 00000000..7fce461f --- /dev/null +++ b/test/test_inline_response2012_setups_risk.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2012_setups_risk import InlineResponse2012SetupsRisk + + +class TestInlineResponse2012SetupsRisk(unittest.TestCase): + """ InlineResponse2012SetupsRisk unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2012SetupsRisk(self): + """ + Test InlineResponse2012SetupsRisk + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2012_setups_risk.InlineResponse2012SetupsRisk() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2011_setups_value_added_services.py b/test/test_inline_response2012_setups_value_added_services.py similarity index 58% rename from test/test_inline_response2011_setups_value_added_services.py rename to test/test_inline_response2012_setups_value_added_services.py index 7dcb16a8..71ad2c16 100644 --- a/test/test_inline_response2011_setups_value_added_services.py +++ b/test/test_inline_response2012_setups_value_added_services.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2011_setups_value_added_services import InlineResponse2011SetupsValueAddedServices +from CyberSource.models.inline_response2012_setups_value_added_services import InlineResponse2012SetupsValueAddedServices -class TestInlineResponse2011SetupsValueAddedServices(unittest.TestCase): - """ InlineResponse2011SetupsValueAddedServices unit test stubs """ +class TestInlineResponse2012SetupsValueAddedServices(unittest.TestCase): + """ InlineResponse2012SetupsValueAddedServices unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2011SetupsValueAddedServices(self): + def testInlineResponse2012SetupsValueAddedServices(self): """ - Test InlineResponse2011SetupsValueAddedServices + Test InlineResponse2012SetupsValueAddedServices """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2011_setups_value_added_services.InlineResponse2011SetupsValueAddedServices() + #model = CyberSource.models.inline_response2012_setups_value_added_services.InlineResponse2012SetupsValueAddedServices() pass diff --git a/test/test_inline_response2013_key_information.py b/test/test_inline_response2013_key_information.py new file mode 100644 index 00000000..c00bd39d --- /dev/null +++ b/test/test_inline_response2013_key_information.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2013_key_information import InlineResponse2013KeyInformation + + +class TestInlineResponse2013KeyInformation(unittest.TestCase): + """ InlineResponse2013KeyInformation unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2013KeyInformation(self): + """ + Test InlineResponse2013KeyInformation + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2013_key_information.InlineResponse2013KeyInformation() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_inline_response2012_key_information_error_information.py b/test/test_inline_response2013_key_information_error_information.py similarity index 58% rename from test/test_inline_response2012_key_information_error_information.py rename to test/test_inline_response2013_key_information_error_information.py index 623f4047..6424da1a 100644 --- a/test/test_inline_response2012_key_information_error_information.py +++ b/test/test_inline_response2013_key_information_error_information.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2012_key_information_error_information import InlineResponse2012KeyInformationErrorInformation +from CyberSource.models.inline_response2013_key_information_error_information import InlineResponse2013KeyInformationErrorInformation -class TestInlineResponse2012KeyInformationErrorInformation(unittest.TestCase): - """ InlineResponse2012KeyInformationErrorInformation unit test stubs """ +class TestInlineResponse2013KeyInformationErrorInformation(unittest.TestCase): + """ InlineResponse2013KeyInformationErrorInformation unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2012KeyInformationErrorInformation(self): + def testInlineResponse2013KeyInformationErrorInformation(self): """ - Test InlineResponse2012KeyInformationErrorInformation + Test InlineResponse2013KeyInformationErrorInformation """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2012_key_information_error_information.InlineResponse2012KeyInformationErrorInformation() + #model = CyberSource.models.inline_response2013_key_information_error_information.InlineResponse2013KeyInformationErrorInformation() pass diff --git a/test/test_inline_response2012_key_information_error_information_details.py b/test/test_inline_response2013_key_information_error_information_details.py similarity index 60% rename from test/test_inline_response2012_key_information_error_information_details.py rename to test/test_inline_response2013_key_information_error_information_details.py index e43e04e6..27a16260 100644 --- a/test/test_inline_response2012_key_information_error_information_details.py +++ b/test/test_inline_response2013_key_information_error_information_details.py @@ -18,11 +18,11 @@ import CyberSource from CyberSource.rest import ApiException -from CyberSource.models.inline_response2012_key_information_error_information_details import InlineResponse2012KeyInformationErrorInformationDetails +from CyberSource.models.inline_response2013_key_information_error_information_details import InlineResponse2013KeyInformationErrorInformationDetails -class TestInlineResponse2012KeyInformationErrorInformationDetails(unittest.TestCase): - """ InlineResponse2012KeyInformationErrorInformationDetails unit test stubs """ +class TestInlineResponse2013KeyInformationErrorInformationDetails(unittest.TestCase): + """ InlineResponse2013KeyInformationErrorInformationDetails unit test stubs """ def setUp(self): pass @@ -30,12 +30,12 @@ def setUp(self): def tearDown(self): pass - def testInlineResponse2012KeyInformationErrorInformationDetails(self): + def testInlineResponse2013KeyInformationErrorInformationDetails(self): """ - Test InlineResponse2012KeyInformationErrorInformationDetails + Test InlineResponse2013KeyInformationErrorInformationDetails """ # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.inline_response2012_key_information_error_information_details.InlineResponse2012KeyInformationErrorInformationDetails() + #model = CyberSource.models.inline_response2013_key_information_error_information_details.InlineResponse2013KeyInformationErrorInformationDetails() pass diff --git a/test/test_inline_response2015.py b/test/test_inline_response2015.py new file mode 100644 index 00000000..d7137dfc --- /dev/null +++ b/test/test_inline_response2015.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.inline_response2015 import InlineResponse2015 + + +class TestInlineResponse2015(unittest.TestCase): + """ InlineResponse2015 unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testInlineResponse2015(self): + """ + Test InlineResponse2015 + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.inline_response2015.InlineResponse2015() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_pts_v2_payments_post201_response_payment_insights_information_orchestration.py b/test/test_pts_v2_payments_post201_response_payment_insights_information_orchestration.py new file mode 100644 index 00000000..e2ff6948 --- /dev/null +++ b/test/test_pts_v2_payments_post201_response_payment_insights_information_orchestration.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.pts_v2_payments_post201_response_payment_insights_information_orchestration import PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration + + +class TestPtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration(unittest.TestCase): + """ PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration(self): + """ + Test PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.pts_v2_payments_post201_response_payment_insights_information_orchestration.PtsV2PaymentsPost201ResponsePaymentInsightsInformationOrchestration() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_ptsv2payments_payment_information_payment_account_reference.py b/test/test_ptsv2payments_payment_information_payment_account_reference.py new file mode 100644 index 00000000..96b28be3 --- /dev/null +++ b/test/test_ptsv2payments_payment_information_payment_account_reference.py @@ -0,0 +1,43 @@ +# coding: utf-8 + +""" + CyberSource Merged Spec + + All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + + OpenAPI spec version: 0.0.1 + + Generated by: https://github.com/swagger-api/swagger-codegen.git +""" + +from __future__ import absolute_import + +import os +import sys +import unittest + +import CyberSource +from CyberSource.rest import ApiException +from CyberSource.models.ptsv2payments_payment_information_payment_account_reference import Ptsv2paymentsPaymentInformationPaymentAccountReference + + +class TestPtsv2paymentsPaymentInformationPaymentAccountReference(unittest.TestCase): + """ Ptsv2paymentsPaymentInformationPaymentAccountReference unit test stubs """ + + def setUp(self): + pass + + def tearDown(self): + pass + + def testPtsv2paymentsPaymentInformationPaymentAccountReference(self): + """ + Test Ptsv2paymentsPaymentInformationPaymentAccountReference + """ + # FIXME: construct object with mandatory attributes with example values + #model = CyberSource.models.ptsv2payments_payment_information_payment_account_reference.Ptsv2paymentsPaymentInformationPaymentAccountReference() + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_tss_v2_transactions_post400_response.py b/test/test_tss_v2_transactions_post400_response.py deleted file mode 100644 index 8a000c2f..00000000 --- a/test/test_tss_v2_transactions_post400_response.py +++ /dev/null @@ -1,43 +0,0 @@ -# coding: utf-8 - -""" - CyberSource Merged Spec - - All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html - - OpenAPI spec version: 0.0.1 - - Generated by: https://github.com/swagger-api/swagger-codegen.git -""" - -from __future__ import absolute_import - -import os -import sys -import unittest - -import CyberSource -from CyberSource.rest import ApiException -from CyberSource.models.tss_v2_transactions_post400_response import TssV2TransactionsPost400Response - - -class TestTssV2TransactionsPost400Response(unittest.TestCase): - """ TssV2TransactionsPost400Response unit test stubs """ - - def setUp(self): - pass - - def tearDown(self): - pass - - def testTssV2TransactionsPost400Response(self): - """ - Test TssV2TransactionsPost400Response - """ - # FIXME: construct object with mandatory attributes with example values - #model = CyberSource.models.tss_v2_transactions_post400_response.TssV2TransactionsPost400Response() - pass - - -if __name__ == '__main__': - unittest.main() From 8871da07937d4a592ff3c5bf5b8fa655f13a2215 Mon Sep 17 00:00:00 2001 From: gaubansa <101095184+gaubansa@users.noreply.github.com> Date: Tue, 30 Jul 2024 16:20:23 +0530 Subject: [PATCH 2/2] version update --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index af041edf..7a802834 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ from setuptools import setup, find_packages NAME = "cybersource-rest-client-python" -VERSION = "0.0.56" +VERSION = "0.0.57" # To install the library, run the following # # python setup.py install