cybersource_rest_client 0.0.56 → 0.0.58

Sign up to get free protection for your applications and to get access to all the features.
Files changed (370) hide show
  1. checksums.yaml +4 -4
  2. data/lib/AuthenticationSDK/core/Authorization.rb +1 -1
  3. data/lib/cybersource_rest_client/api/asymmetric_key_management_api.rb +8 -0
  4. data/lib/cybersource_rest_client/api/batches_api.rb +14 -26
  5. data/lib/cybersource_rest_client/api/billing_agreements_api.rb +6 -0
  6. data/lib/cybersource_rest_client/api/capture_api.rb +2 -0
  7. data/lib/cybersource_rest_client/api/chargeback_details_api.rb +2 -8
  8. data/lib/cybersource_rest_client/api/chargeback_summaries_api.rb +2 -8
  9. data/lib/cybersource_rest_client/api/conversion_details_api.rb +2 -8
  10. data/lib/cybersource_rest_client/api/create_new_webhooks_api.rb +21 -37
  11. data/lib/cybersource_rest_client/api/credit_api.rb +2 -0
  12. data/lib/cybersource_rest_client/api/customer_api.rb +8 -64
  13. data/lib/cybersource_rest_client/api/customer_payment_instrument_api.rb +10 -124
  14. data/lib/cybersource_rest_client/api/customer_shipping_address_api.rb +10 -124
  15. data/lib/cybersource_rest_client/api/decision_manager_api.rb +10 -0
  16. data/lib/cybersource_rest_client/api/download_dtd_api.rb +2 -0
  17. data/lib/cybersource_rest_client/api/download_xsd_api.rb +2 -0
  18. data/lib/cybersource_rest_client/api/emv_tag_details_api.rb +4 -0
  19. data/lib/cybersource_rest_client/api/instrument_identifier_api.rb +12 -108
  20. data/lib/cybersource_rest_client/api/interchange_clearing_level_details_api.rb +2 -8
  21. data/lib/cybersource_rest_client/api/invoice_settings_api.rb +4 -0
  22. data/lib/cybersource_rest_client/api/invoices_api.rb +12 -0
  23. data/lib/cybersource_rest_client/api/keymanagement_api.rb +2 -0
  24. data/lib/cybersource_rest_client/api/keymanagementpassword_api.rb +2 -0
  25. data/lib/cybersource_rest_client/api/keymanagementpgp_api.rb +2 -0
  26. data/lib/cybersource_rest_client/api/keymanagementscmp_api.rb +2 -0
  27. data/lib/cybersource_rest_client/api/manage_webhooks_api.rb +77 -93
  28. data/lib/cybersource_rest_client/api/merchant_boarding_api.rb +2 -2
  29. data/lib/cybersource_rest_client/api/microform_integration_api.rb +2 -0
  30. data/lib/cybersource_rest_client/api/net_fundings_api.rb +2 -8
  31. data/lib/cybersource_rest_client/api/notification_of_changes_api.rb +2 -0
  32. data/lib/cybersource_rest_client/api/payer_authentication_api.rb +6 -0
  33. data/lib/cybersource_rest_client/api/payment_batch_summaries_api.rb +2 -16
  34. data/lib/cybersource_rest_client/api/payment_instrument_api.rb +8 -64
  35. data/lib/cybersource_rest_client/api/payments_api.rb +6 -0
  36. data/lib/cybersource_rest_client/api/payouts_api.rb +2 -0
  37. data/lib/cybersource_rest_client/api/plans_api.rb +16 -0
  38. data/lib/cybersource_rest_client/api/purchase_and_refund_details_api.rb +2 -16
  39. data/lib/cybersource_rest_client/api/push_funds_api.rb +2 -0
  40. data/lib/cybersource_rest_client/api/refund_api.rb +4 -0
  41. data/lib/cybersource_rest_client/api/report_definitions_api.rb +4 -16
  42. data/lib/cybersource_rest_client/api/report_downloads_api.rb +2 -8
  43. data/lib/cybersource_rest_client/api/report_subscriptions_api.rb +12 -58
  44. data/lib/cybersource_rest_client/api/reports_api.rb +8 -26
  45. data/lib/cybersource_rest_client/api/retrieval_details_api.rb +2 -8
  46. data/lib/cybersource_rest_client/api/retrieval_summaries_api.rb +2 -8
  47. data/lib/cybersource_rest_client/api/reversal_api.rb +4 -0
  48. data/lib/cybersource_rest_client/api/search_transactions_api.rb +4 -0
  49. data/lib/cybersource_rest_client/api/secure_file_share_api.rb +4 -16
  50. data/lib/cybersource_rest_client/api/subscriptions_api.rb +16 -0
  51. data/lib/cybersource_rest_client/api/symmetric_key_management_api.rb +8 -0
  52. data/lib/cybersource_rest_client/api/taxes_api.rb +4 -0
  53. data/lib/cybersource_rest_client/api/token_api.rb +13 -23
  54. data/lib/cybersource_rest_client/api/transaction_batches_api.rb +6 -0
  55. data/lib/cybersource_rest_client/api/transaction_details_api.rb +2 -0
  56. data/lib/cybersource_rest_client/api/transient_token_data_api.rb +2 -0
  57. data/lib/cybersource_rest_client/api/unified_checkout_capture_context_api.rb +2 -0
  58. data/lib/cybersource_rest_client/api/user_management_api.rb +2 -0
  59. data/lib/cybersource_rest_client/api/user_management_search_api.rb +2 -0
  60. data/lib/cybersource_rest_client/api/verification_api.rb +4 -0
  61. data/lib/cybersource_rest_client/api/void_api.rb +10 -0
  62. data/lib/cybersource_rest_client/models/boardingv1registrations_product_information_selected_products.rb +1 -1
  63. data/lib/cybersource_rest_client/models/check_payer_auth_enrollment_request.rb +1 -1
  64. data/lib/cybersource_rest_client/models/commerce_solutions_products_account_updater.rb +1 -1
  65. data/lib/cybersource_rest_client/models/commerce_solutions_products_bin_lookup.rb +1 -1
  66. data/lib/cybersource_rest_client/models/commerce_solutions_products_token_management.rb +1 -1
  67. data/lib/cybersource_rest_client/models/create_bundled_decision_manager_case_request.rb +1 -1
  68. data/lib/cybersource_rest_client/models/create_search_request.rb +1 -1
  69. data/lib/cybersource_rest_client/models/{create_webhook.rb → create_webhook_request.rb} +1 -1
  70. data/lib/cybersource_rest_client/models/get_all_subscriptions_response_order_information_bill_to.rb +2 -2
  71. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_customer_information.rb +1 -1
  72. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get404_response.rb +1 -1
  73. data/lib/cybersource_rest_client/models/invoicingv2invoices_customer_information.rb +1 -1
  74. data/lib/cybersource_rest_client/models/invoicingv2invoices_customer_information_company.rb +1 -1
  75. data/lib/cybersource_rest_client/models/kms_v2_keys_asym_deletes_post200_response_key_information.rb +1 -1
  76. data/lib/cybersource_rest_client/models/kms_v2_keys_asym_get200_response_key_information.rb +1 -1
  77. data/lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb +1 -1
  78. data/lib/cybersource_rest_client/models/kms_v2_keys_sym_post201_response_key_information.rb +1 -1
  79. data/lib/cybersource_rest_client/models/kmsv2keysasym_key_information.rb +1 -1
  80. data/lib/cybersource_rest_client/models/kmsv2keyssym_key_information.rb +1 -1
  81. data/lib/cybersource_rest_client/models/kmsv2keyssymdeletes_key_information.rb +1 -1
  82. data/lib/cybersource_rest_client/models/kmsv2keyssymverifi_key_information.rb +1 -1
  83. data/lib/cybersource_rest_client/models/payment_products_card_processing_config_card_not_present.rb +4 -4
  84. data/lib/cybersource_rest_client/models/payment_products_card_processing_config_card_not_present_installment.rb +1 -1
  85. data/lib/cybersource_rest_client/models/payment_products_card_processing_config_card_not_present_payouts.rb +2 -2
  86. data/lib/cybersource_rest_client/models/payment_products_card_processing_config_card_not_present_processors.rb +2 -2
  87. data/lib/cybersource_rest_client/models/payment_products_card_processing_config_card_present_processors.rb +1 -1
  88. data/lib/cybersource_rest_client/models/payment_products_card_processing_config_common_merchant_descriptor_info.rb +2 -2
  89. data/lib/cybersource_rest_client/models/payment_products_card_processing_config_features_card_not_present_payouts_currencies.rb +1 -1
  90. data/lib/cybersource_rest_client/models/payment_products_e_check_config_account_validation_service.rb +3 -3
  91. data/lib/cybersource_rest_client/models/payment_products_e_check_config_account_validation_service_internal_only.rb +1 -1
  92. data/lib/cybersource_rest_client/models/payment_products_e_check_config_account_validation_service_processors.rb +1 -1
  93. data/lib/cybersource_rest_client/models/payment_products_payer_authentication_config_card_types_j_cbj_secure.rb +2 -2
  94. data/lib/cybersource_rest_client/models/payment_products_payer_authentication_config_card_types_verified.rb +2 -2
  95. data/lib/cybersource_rest_client/models/payment_products_payer_authentication_config_card_types_verified_currencies.rb +1 -1
  96. data/lib/cybersource_rest_client/models/payment_products_secure_acceptance_config_notifications_customer_notifications.rb +1 -1
  97. data/lib/cybersource_rest_client/models/payment_products_secure_acceptance_config_notifications_merchant_notifications.rb +1 -1
  98. data/lib/cybersource_rest_client/models/payment_products_secure_acceptance_config_payment_types_card_types.rb +5 -5
  99. data/lib/cybersource_rest_client/models/payment_products_secure_acceptance_config_payment_types_card_types_discover.rb +1 -1
  100. data/lib/cybersource_rest_client/models/payment_products_virtual_terminal_config_card_not_present_global_payment_info.rb +4 -4
  101. data/lib/cybersource_rest_client/models/payment_products_virtual_terminal_config_card_not_present_global_payment_info_basic_info.rb +1 -1
  102. data/lib/cybersource_rest_client/models/payment_products_virtual_terminal_config_card_not_present_merchant_defined_data_fields.rb +1 -1
  103. data/lib/cybersource_rest_client/models/payment_products_virtual_terminal_config_card_not_present_payment_info.rb +1 -1
  104. data/lib/cybersource_rest_client/models/payment_products_virtual_terminal_config_card_not_present_receipt_info.rb +4 -4
  105. data/lib/cybersource_rest_client/models/payment_products_virtual_terminal_config_card_not_present_receipt_info_email_receipt.rb +1 -1
  106. data/lib/cybersource_rest_client/models/payment_products_virtual_terminal_config_card_not_present_receipt_info_header.rb +1 -1
  107. data/lib/cybersource_rest_client/models/payment_products_virtual_terminal_config_card_not_present_receipt_info_order_info.rb +1 -1
  108. data/lib/cybersource_rest_client/models/{payment_products.rb → payments_products.rb} +18 -18
  109. data/lib/cybersource_rest_client/models/{payment_products_currency_conversion.rb → payments_products_card_present_connect.rb} +3 -3
  110. data/lib/cybersource_rest_client/models/{payment_products_currency_conversion_configuration_information.rb → payments_products_card_present_connect_configuration_information.rb} +2 -2
  111. data/lib/cybersource_rest_client/models/{payment_products_card_present_connect_configuration_information_configurations.rb → payments_products_card_present_connect_configuration_information_configurations.rb} +1 -1
  112. data/lib/cybersource_rest_client/models/{payment_products_card_present_connect_subscription_information.rb → payments_products_card_present_connect_subscription_information.rb} +1 -1
  113. data/lib/cybersource_rest_client/models/{payment_products_card_processing.rb → payments_products_card_processing.rb} +3 -3
  114. data/lib/cybersource_rest_client/models/{payment_products_virtual_terminal_configuration_information.rb → payments_products_card_processing_configuration_information.rb} +2 -2
  115. data/lib/cybersource_rest_client/models/{payment_products_card_processing_configuration_information_configurations.rb → payments_products_card_processing_configuration_information_configurations.rb} +3 -3
  116. data/lib/cybersource_rest_client/models/{payment_products_card_processing_configuration_information_configurations_common.rb → payments_products_card_processing_configuration_information_configurations_common.rb} +4 -4
  117. data/lib/cybersource_rest_client/models/{payment_products_card_processing_configuration_information_configurations_common_acquirer.rb → payments_products_card_processing_configuration_information_configurations_common_acquirer.rb} +1 -1
  118. data/lib/cybersource_rest_client/models/{payment_products_card_processing_configuration_information_configurations_common_currencies.rb → payments_products_card_processing_configuration_information_configurations_common_currencies.rb} +1 -1
  119. data/lib/cybersource_rest_client/models/{payment_products_card_processing_configuration_information_configurations_common_currencies_1.rb → payments_products_card_processing_configuration_information_configurations_common_currencies_1.rb} +1 -1
  120. data/lib/cybersource_rest_client/models/{payment_products_card_processing_configuration_information_configurations_common_payment_types.rb → payments_products_card_processing_configuration_information_configurations_common_payment_types.rb} +2 -2
  121. data/lib/cybersource_rest_client/models/{payment_products_card_processing_configuration_information_configurations_common_processors.rb → payments_products_card_processing_configuration_information_configurations_common_processors.rb} +10 -10
  122. data/lib/cybersource_rest_client/models/{payment_products_card_processing_configuration_information_configurations_features.rb → payments_products_card_processing_configuration_information_configurations_features.rb} +3 -3
  123. data/lib/cybersource_rest_client/models/{payment_products_card_processing_configuration_information_configurations_features_card_present.rb → payments_products_card_processing_configuration_information_configurations_features_card_present.rb} +2 -2
  124. data/lib/cybersource_rest_client/models/{payment_products_card_processing_subscription_information.rb → payments_products_card_processing_subscription_information.rb} +2 -2
  125. data/lib/cybersource_rest_client/models/{payment_products_card_processing_subscription_information_features.rb → payments_products_card_processing_subscription_information_features.rb} +1 -1
  126. data/lib/cybersource_rest_client/models/payments_products_currency_conversion.rb +200 -0
  127. data/lib/cybersource_rest_client/models/{payment_products_payer_authentication_configuration_information.rb → payments_products_currency_conversion_configuration_information.rb} +2 -2
  128. data/lib/cybersource_rest_client/models/{payment_products_currency_conversion_configuration_information_configurations.rb → payments_products_currency_conversion_configuration_information_configurations.rb} +2 -2
  129. data/lib/cybersource_rest_client/models/{payment_products_currency_conversion_configuration_information_configurations_processors.rb → payments_products_currency_conversion_configuration_information_configurations_processors.rb} +1 -1
  130. data/lib/cybersource_rest_client/models/{payment_products_cybs_ready_terminal.rb → payments_products_cybs_ready_terminal.rb} +2 -2
  131. data/lib/cybersource_rest_client/models/{payment_products_differential_fee.rb → payments_products_differential_fee.rb} +2 -2
  132. data/lib/cybersource_rest_client/models/{payment_products_differential_fee_subscription_information.rb → payments_products_differential_fee_subscription_information.rb} +2 -2
  133. data/lib/cybersource_rest_client/models/{payment_products_differential_fee_subscription_information_features.rb → payments_products_differential_fee_subscription_information_features.rb} +2 -2
  134. data/lib/cybersource_rest_client/models/{payment_products_digital_payments.rb → payments_products_digital_payments.rb} +2 -2
  135. data/lib/cybersource_rest_client/models/{payment_products_digital_payments_subscription_information.rb → payments_products_digital_payments_subscription_information.rb} +2 -2
  136. data/lib/cybersource_rest_client/models/{payment_products_payouts.rb → payments_products_e_check.rb} +3 -3
  137. data/lib/cybersource_rest_client/models/{payment_products_e_check_configuration_information_configurations_common_internal_only_processors.rb → payments_products_e_check_config_common_internal_only_processors.rb} +1 -1
  138. data/lib/cybersource_rest_client/models/{payment_products_e_check_configuration_information.rb → payments_products_e_check_configuration_information.rb} +2 -2
  139. data/lib/cybersource_rest_client/models/{payment_products_e_check_configuration_information_configurations.rb → payments_products_e_check_configuration_information_configurations.rb} +4 -4
  140. data/lib/cybersource_rest_client/models/{payment_products_e_check_configuration_information_configurations_common.rb → payments_products_e_check_configuration_information_configurations_common.rb} +3 -3
  141. data/lib/cybersource_rest_client/models/{payment_products_e_check_configuration_information_configurations_common_internal_only.rb → payments_products_e_check_configuration_information_configurations_common_internal_only.rb} +2 -2
  142. data/lib/cybersource_rest_client/models/{payment_products_e_check_configuration_information_configurations_common_processors.rb → payments_products_e_check_configuration_information_configurations_common_processors.rb} +1 -1
  143. data/lib/cybersource_rest_client/models/{payment_products_e_check_configuration_information_configurations_features.rb → payments_products_e_check_configuration_information_configurations_features.rb} +2 -2
  144. data/lib/cybersource_rest_client/models/{payment_products_e_check_configuration_information_configurations_underwriting.rb → payments_products_e_check_configuration_information_configurations_underwriting.rb} +4 -4
  145. data/lib/cybersource_rest_client/models/{payment_products_e_check_subscription_information.rb → payments_products_e_check_subscription_information.rb} +1 -1
  146. data/lib/cybersource_rest_client/models/payments_products_payer_authentication.rb +200 -0
  147. data/lib/cybersource_rest_client/models/{payment_products_card_present_connect_configuration_information.rb → payments_products_payer_authentication_configuration_information.rb} +2 -2
  148. data/lib/cybersource_rest_client/models/{payment_products_payer_authentication_configuration_information_configurations.rb → payments_products_payer_authentication_configuration_information_configurations.rb} +2 -2
  149. data/lib/cybersource_rest_client/models/{payment_products_payer_authentication_configuration_information_configurations_card_types.rb → payments_products_payer_authentication_configuration_information_configurations_card_types.rb} +9 -9
  150. data/lib/cybersource_rest_client/models/{payment_products_payer_authentication_configuration_information_configurations_card_types_cb.rb → payments_products_payer_authentication_configuration_information_configurations_card_types_cb.rb} +2 -2
  151. data/lib/cybersource_rest_client/models/{payment_products_payer_authentication_subscription_information.rb → payments_products_payer_authentication_subscription_information.rb} +1 -1
  152. data/lib/cybersource_rest_client/models/{payment_products_e_check.rb → payments_products_payouts.rb} +3 -3
  153. data/lib/cybersource_rest_client/models/{payment_products_payouts_configuration_information.rb → payments_products_payouts_configuration_information.rb} +2 -2
  154. data/lib/cybersource_rest_client/models/{payment_products_payouts_configuration_information_configurations.rb → payments_products_payouts_configuration_information_configurations.rb} +3 -3
  155. data/lib/cybersource_rest_client/models/{payment_products_payouts_configuration_information_configurations_processor_account.rb → payments_products_payouts_configuration_information_configurations_processor_account.rb} +1 -1
  156. data/lib/cybersource_rest_client/models/{payment_products_payouts_configuration_information_configurations_pullfunds.rb → payments_products_payouts_configuration_information_configurations_pullfunds.rb} +1 -1
  157. data/lib/cybersource_rest_client/models/{payment_products_payouts_configuration_information_configurations_pushfunds.rb → payments_products_payouts_configuration_information_configurations_pushfunds.rb} +2 -2
  158. data/lib/cybersource_rest_client/models/{payment_products_card_present_connect.rb → payments_products_secure_acceptance.rb} +3 -3
  159. data/lib/cybersource_rest_client/models/{payment_products_card_processing_configuration_information.rb → payments_products_secure_acceptance_configuration_information.rb} +2 -2
  160. data/lib/cybersource_rest_client/models/{payment_products_secure_acceptance_configuration_information_configurations.rb → payments_products_secure_acceptance_configuration_information_configurations.rb} +7 -7
  161. data/lib/cybersource_rest_client/models/{payment_products_secure_acceptance_configuration_information_configurations_checkout.rb → payments_products_secure_acceptance_configuration_information_configurations_checkout.rb} +1 -1
  162. data/lib/cybersource_rest_client/models/{payment_products_secure_acceptance_configuration_information_configurations_contact_information.rb → payments_products_secure_acceptance_configuration_information_configurations_contact_information.rb} +1 -1
  163. data/lib/cybersource_rest_client/models/{payment_products_secure_acceptance_configuration_information_configurations_notifications.rb → payments_products_secure_acceptance_configuration_information_configurations_notifications.rb} +3 -3
  164. data/lib/cybersource_rest_client/models/{payment_products_secure_acceptance_configuration_information_configurations_payment_methods.rb → payments_products_secure_acceptance_configuration_information_configurations_payment_methods.rb} +1 -1
  165. data/lib/cybersource_rest_client/models/{payment_products_secure_acceptance_configuration_information_configurations_payment_types.rb → payments_products_secure_acceptance_configuration_information_configurations_payment_types.rb} +2 -2
  166. data/lib/cybersource_rest_client/models/{payment_products_secure_acceptance_configuration_information_configurations_service.rb → payments_products_secure_acceptance_configuration_information_configurations_service.rb} +1 -1
  167. data/lib/cybersource_rest_client/models/{payment_products_tax.rb → payments_products_tax.rb} +2 -2
  168. data/lib/cybersource_rest_client/models/{payment_products_secure_acceptance.rb → payments_products_virtual_terminal.rb} +3 -3
  169. data/lib/cybersource_rest_client/models/{payment_products_secure_acceptance_configuration_information.rb → payments_products_virtual_terminal_configuration_information.rb} +2 -2
  170. data/lib/cybersource_rest_client/models/{payment_products_virtual_terminal_configuration_information_configurations.rb → payments_products_virtual_terminal_configuration_information_configurations.rb} +3 -3
  171. data/lib/cybersource_rest_client/models/{payment_products_virtual_terminal_configuration_information_configurations_card_not_present.rb → payments_products_virtual_terminal_configuration_information_configurations_card_not_present.rb} +3 -3
  172. data/lib/cybersource_rest_client/models/post_payment_credentials_request.rb +191 -0
  173. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response_credit_amount_details.rb +1 -1
  174. data/lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb +1 -1
  175. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post201_response.rb +1 -1
  176. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post201_response_processor_information.rb +16 -5
  177. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_1_order_information_bill_to.rb +4 -4
  178. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_1_order_information_ship_to.rb +6 -6
  179. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_1_payment_information_payment_type_method.rb +1 -1
  180. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_buyer_information.rb +3 -3
  181. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_consumer_authentication_information.rb +4 -4
  182. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_embedded_actions_capture.rb +1 -1
  183. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb +3 -3
  184. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_issuer_information.rb +1 -1
  185. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_account_information_card.rb +1 -1
  186. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb +1 -1
  187. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb +1 -1
  188. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information_emv.rb +1 -1
  189. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information.rb +3 -3
  190. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_electronic_verification_results.rb +18 -18
  191. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_info_codes.rb +3 -3
  192. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_score.rb +1 -1
  193. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_watchlist_screening_information.rb +1 -1
  194. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_refund_amount_details.rb +1 -1
  195. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_merchant_information_merchant_descriptor.rb +3 -3
  196. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_order_information_amount_details.rb +1 -1
  197. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_processor_information.rb +1 -1
  198. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_aggregator_information_sub_merchant.rb +8 -8
  199. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_merchant_information.rb +1 -1
  200. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_merchant_information_merchant_descriptor.rb +4 -4
  201. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_point_of_service_information.rb +1 -1
  202. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb +1 -1
  203. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb +1 -1
  204. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information_payment_information_card.rb +1 -1
  205. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb +4 -4
  206. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information_account.rb +1 -1
  207. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information_payment_information_card.rb +1 -1
  208. data/lib/cybersource_rest_client/models/ptsv2billingagreements_device_information.rb +2 -2
  209. data/lib/cybersource_rest_client/models/ptsv2billingagreements_installment_information.rb +1 -1
  210. data/lib/cybersource_rest_client/models/ptsv2billingagreements_merchant_information.rb +2 -2
  211. data/lib/cybersource_rest_client/models/ptsv2billingagreements_merchant_information_merchant_descriptor.rb +3 -3
  212. data/lib/cybersource_rest_client/models/ptsv2billingagreements_order_information_bill_to.rb +5 -5
  213. data/lib/cybersource_rest_client/models/ptsv2billingagreements_payment_information_card.rb +1 -1
  214. data/lib/cybersource_rest_client/models/ptsv2billingagreements_payment_information_tokenized_card.rb +2 -2
  215. data/lib/cybersource_rest_client/models/ptsv2credits_installment_information.rb +1 -1
  216. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb +3 -3
  217. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb +1 -1
  218. data/lib/cybersource_rest_client/models/ptsv2payments_acquirer_information.rb +22 -5
  219. data/lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb +9 -9
  220. data/lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb +5 -5
  221. data/lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb +1 -1
  222. data/lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb +1 -1
  223. data/lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb +1 -1
  224. data/lib/cybersource_rest_client/models/ptsv2payments_device_information.rb +5 -5
  225. data/lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb +3 -3
  226. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb +4 -4
  227. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb +5 -5
  228. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information_service_fee_descriptor.rb +3 -3
  229. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information_service_location.rb +4 -4
  230. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb +2 -2
  231. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb +9 -9
  232. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to_company.rb +1 -1
  233. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb +1 -1
  234. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details_transaction_advice_addendum.rb +1 -1
  235. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb +1 -1
  236. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb +7 -7
  237. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_bank.rb +2 -2
  238. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_bank_account.rb +1 -1
  239. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb +2 -2
  240. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_customer.rb +1 -1
  241. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_payment_type_method.rb +1 -1
  242. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb +3 -3
  243. data/lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb +4 -4
  244. data/lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information_emv.rb +2 -2
  245. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information.rb +6 -6
  246. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb +1 -1
  247. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options_initiator.rb +1 -1
  248. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb +2 -2
  249. data/lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb +5 -5
  250. data/lib/cybersource_rest_client/models/ptsv2payments_risk_information_buyer_history_customer_account.rb +1 -1
  251. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental.rb +4 -4
  252. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_transit_airline.rb +1 -1
  253. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_transit_airline_ancillary_information.rb +1 -1
  254. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_transit_airline_legs.rb +1 -1
  255. data/lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information.rb +1 -1
  256. data/lib/cybersource_rest_client/models/ptsv2payments_watchlist_screening_information_weights.rb +2 -2
  257. data/lib/cybersource_rest_client/models/ptsv2paymentsid_client_reference_information_partner.rb +1 -1
  258. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_aggregator_information_sub_merchant.rb +8 -8
  259. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_buyer_information.rb +3 -3
  260. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_device_information.rb +1 -1
  261. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb +3 -3
  262. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb +1 -1
  263. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb +1 -1
  264. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_bill_to.rb +6 -6
  265. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_invoice_details.rb +1 -1
  266. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb +3 -3
  267. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_point_of_sale_information_emv.rb +1 -1
  268. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_merchant_information.rb +1 -1
  269. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_order_information_line_items.rb +1 -1
  270. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_bank.rb +1 -1
  271. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_card.rb +2 -2
  272. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_point_of_sale_information_emv.rb +1 -1
  273. data/lib/cybersource_rest_client/models/ptsv2payouts_merchant_information.rb +1 -1
  274. data/lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb +5 -5
  275. data/lib/cybersource_rest_client/models/ptsv2payouts_order_information_bill_to.rb +4 -4
  276. data/lib/cybersource_rest_client/models/ptsv2payouts_payment_information_card.rb +1 -1
  277. data/lib/cybersource_rest_client/models/ptsv2payouts_processing_information.rb +1 -1
  278. data/lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb +1 -1
  279. data/lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb +5 -5
  280. data/lib/cybersource_rest_client/models/ptsv2payouts_sender_information_account.rb +1 -1
  281. data/lib/cybersource_rest_client/models/ptsv2refreshpaymentstatusid_payment_information_customer.rb +1 -1
  282. data/lib/cybersource_rest_client/models/push_funds201_response_order_information_amount_details.rb +1 -1
  283. data/lib/cybersource_rest_client/models/push_funds201_response_processor_information.rb +1 -1
  284. data/lib/cybersource_rest_client/models/{replay_webhooks.rb → replay_webhooks_request.rb} +1 -1
  285. data/lib/cybersource_rest_client/models/risk_products_decision_manager.rb +1 -1
  286. data/lib/cybersource_rest_client/models/risk_products_fraud_management_essentials.rb +1 -1
  287. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb +4 -4
  288. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_payment_information.rb +1 -1
  289. data/lib/cybersource_rest_client/models/riskv1addressverifications_buyer_information.rb +1 -1
  290. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb +1 -1
  291. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb +1 -1
  292. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_ship_to.rb +7 -7
  293. data/lib/cybersource_rest_client/models/riskv1authenticationresults_order_information.rb +5 -17
  294. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information_card.rb +1 -1
  295. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information_tokenized_card.rb +2 -2
  296. data/lib/cybersource_rest_client/models/riskv1authentications_buyer_information.rb +2 -2
  297. data/lib/cybersource_rest_client/models/riskv1authentications_device_information.rb +2 -2
  298. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_bill_to.rb +4 -4
  299. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_card.rb +1 -1
  300. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_tokenized_card.rb +2 -2
  301. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_card.rb +1 -1
  302. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_tokenized_card.rb +2 -2
  303. data/lib/cybersource_rest_client/models/riskv1decisions_acquirer_information.rb +248 -0
  304. data/lib/cybersource_rest_client/models/riskv1decisions_buyer_information.rb +2 -2
  305. data/lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb +1 -1
  306. data/lib/cybersource_rest_client/models/riskv1decisions_device_information.rb +6 -6
  307. data/lib/cybersource_rest_client/models/riskv1decisions_merchant_information.rb +1 -1
  308. data/lib/cybersource_rest_client/models/riskv1decisions_merchant_information_merchant_descriptor.rb +1 -1
  309. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_bill_to.rb +4 -4
  310. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb +2 -2
  311. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb +7 -7
  312. data/lib/cybersource_rest_client/models/riskv1decisions_payment_information_card.rb +1 -1
  313. data/lib/cybersource_rest_client/models/riskv1decisions_payment_information_tokenized_card.rb +2 -2
  314. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_export_compliance_information.rb +1 -1
  315. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_order_information_bill_to.rb +3 -3
  316. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_order_information_line_items.rb +1 -1
  317. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_order_information_ship_to.rb +1 -1
  318. data/lib/cybersource_rest_client/models/riskv1liststypeentries_order_information_bill_to.rb +4 -4
  319. data/lib/cybersource_rest_client/models/riskv1liststypeentries_order_information_ship_to.rb +6 -6
  320. data/lib/cybersource_rest_client/models/riskv1liststypeentries_payment_information_bank.rb +1 -1
  321. data/lib/cybersource_rest_client/models/riskv1liststypeentries_payment_information_card.rb +1 -1
  322. data/lib/cybersource_rest_client/models/riskv1liststypeentries_risk_information_marking_details.rb +2 -2
  323. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument__embedded_instrument_identifier_bill_to.rb +1 -1
  324. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument__embedded_instrument_identifier_card.rb +1 -1
  325. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_bill_to.rb +5 -5
  326. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_buyer_information.rb +1 -1
  327. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_buyer_information_issued_by.rb +1 -1
  328. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card_tokenized_information.rb +2 -2
  329. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_merchant_information_merchant_descriptor.rb +1 -1
  330. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_tokenized_card.rb +24 -2
  331. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_tokenized_card_card.rb +3 -3
  332. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_buyer_information.rb +1 -1
  333. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_device_information.rb +1 -1
  334. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_merchant_information_merchant_descriptor.rb +1 -1
  335. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_amount_details.rb +1 -1
  336. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb +7 -7
  337. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb +6 -6
  338. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_bank.rb +3 -3
  339. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_bank_account.rb +3 -3
  340. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb +2 -2
  341. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_customer.rb +1 -1
  342. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_point_of_sale_information.rb +1 -1
  343. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb +2 -2
  344. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information_authorization_options_initiator.rb +1 -1
  345. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb +2 -2
  346. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information_electronic_verification_results.rb +10 -10
  347. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response.rb +1 -1
  348. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_buyer_information.rb +1 -1
  349. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_order_information_bill_to.rb +4 -4
  350. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_order_information_ship_to.rb +2 -2
  351. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_payment_information_bank_account.rb +1 -1
  352. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_payment_information_card.rb +1 -1
  353. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_point_of_sale_information_partner.rb +1 -1
  354. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_processing_information.rb +2 -2
  355. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_risk_information_providers_fingerprint.rb +1 -1
  356. data/lib/cybersource_rest_client/models/tssv2transactionsemv_tag_details_emv_details_list.rb +1 -1
  357. data/lib/cybersource_rest_client/models/{update_webhook.rb → update_webhook_request.rb} +1 -1
  358. data/lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to.rb +7 -7
  359. data/lib/cybersource_rest_client/models/upv1capturecontexts_order_information_bill_to_company.rb +3 -3
  360. data/lib/cybersource_rest_client/models/value_added_services_products.rb +2 -2
  361. data/lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb +1 -1
  362. data/lib/cybersource_rest_client/models/vasv2tax_buyer_information.rb +1 -1
  363. data/lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb +2 -2
  364. data/lib/cybersource_rest_client/models/vasv2tax_order_information_ship_to.rb +7 -7
  365. data/lib/cybersource_rest_client/models/vasv2tax_tax_information.rb +1 -1
  366. data/lib/cybersource_rest_client.rb +69 -68
  367. metadata +98 -97
  368. data/lib/cybersource_rest_client/models/payment_products_payer_authentication.rb +0 -200
  369. data/lib/cybersource_rest_client/models/payment_products_virtual_terminal.rb +0 -200
  370. data/lib/cybersource_rest_client/models/riskv1authenticationresults_order_information_line_items.rb +0 -240
@@ -14,19 +14,19 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsRecipientInformation
17
- # Identifier for the recipients account. Use the first six digits and last four digits of the recipients 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/)
17
+ # 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/)
18
18
  attr_accessor :account_id
19
19
 
20
- # Recipients 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/)
20
+ # 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/)
21
21
  attr_accessor :last_name
22
22
 
23
- # Recipients 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/)
23
+ # 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/)
24
24
  attr_accessor :middle_name
25
25
 
26
- # Partial postal code for the recipients 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/)
26
+ # 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/)
27
27
  attr_accessor :postal_code
28
28
 
29
- # Recipients 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/)
29
+ # 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/)
30
30
  attr_accessor :date_of_birth
31
31
 
32
32
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsRiskInformationBuyerHistoryCustomerAccount
17
- # Date the cardholders account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added. Recommended for Discover ProtectBuy.
17
+ # Date the cardholder's account was last changed. This includes changes to the billing or shipping address, new payment accounts or new users added. Recommended for Discover ProtectBuy.
18
18
  attr_accessor :last_change_date
19
19
 
20
20
  # The values from the enum can be: - GUEST - NEW_ACCOUNT - EXISTING_ACCOUNT
@@ -26,7 +26,7 @@ module CyberSource
26
26
  # Total number of miles driven by the customer. This field is supported only for MasterCard and American Express.
27
27
  attr_accessor :distance_travelled
28
28
 
29
- # Miles/Kilometers Indicator shows whether the miles fields are expressed in miles or kilometers. Allowed values: - `K` - Kilometers - `M` - Miles
29
+ # Miles/Kilometers Indicator shows whether the \"miles\" fields are expressed in miles or kilometers. Allowed values: - `K` - Kilometers - `M` - Miles
30
30
  attr_accessor :distance_unit
31
31
 
32
32
  # Date/time the auto was returned to the rental agency. Format: ``yyyy-MM-dd HH-mm-ss z`` This field is supported for Visa, MasterCard, and American Express.
@@ -41,14 +41,14 @@ module CyberSource
41
41
  # Used for MC and Discover Valid values: - `true` - Yes (insurance was purchased) - `false` - No (insurance was not purchased)
42
42
  attr_accessor :insurance_indicator
43
43
 
44
- # Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter or show”. This code is `2 digit` value agreed by Merchant and processor.
44
+ # Used to identify special circumstances applicable to the Card Transaction or Cardholder, such as \"renter\" or \"show\". This code is `2 digit` value agreed by Merchant and processor.
45
45
  attr_accessor :program_code
46
46
 
47
47
  attr_accessor :return_address
48
48
 
49
49
  attr_accessor :rental_address
50
50
 
51
- # Auto rental agencys agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions. This field is supported for Visa, MasterCard, and American Express. This Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become part of the descriptive bill on the Cardmember's statement.
51
+ # Auto rental agency's agreement (invoice) number provided to the customer. It is used to trace any inquiries about transactions. This field is supported for Visa, MasterCard, and American Express. This Merchant-defined value, which may be composed of any combination of characters and/or numerals, may become part of the descriptive bill on the Cardmember's statement.
52
52
  attr_accessor :agreement_number
53
53
 
54
54
  # Odometer reading at time of vehicle rental.
@@ -66,7 +66,7 @@ module CyberSource
66
66
  # Age of the driver renting the vehicle.
67
67
  attr_accessor :driver_age
68
68
 
69
- # Program code used to identify special circumstances, such as frequent renter or no show status for the renter. Possible values: - `0`: not applicable (default) - `1`: frequent renter - `2`: no show For authorizations, this field is supported only for Visa. For captures, this field is supported for Visa, MasterCard, and American Express. Code for special programs applicable to the Card Transaction or the Cardholder.
69
+ # Program code used to identify special circumstances, such as \"frequent renter\" or \"no show\" status for the renter. Possible values: - `0`: not applicable (default) - `1`: frequent renter - `2`: no show For authorizations, this field is supported only for Visa. For captures, this field is supported for Visa, MasterCard, and American Express. Code for special programs applicable to the Card Transaction or the Cardholder.
70
70
  attr_accessor :special_program_code
71
71
 
72
72
  # Make of the vehicle being rented (e.g., Chevrolet or Ford).
@@ -79,7 +79,7 @@ module CyberSource
79
79
  # Code that specifies the computerized reservation system used to make the reservation and purchase the ticket. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field.
80
80
  attr_accessor :reservation_system_code
81
81
 
82
- # Airline process identifier. This value is the airlines three-digit IATA1 code which is used to process extended payment airline tickets.
82
+ # Airline process identifier. This value is the airline's three-digit IATA1 code which is used to process extended payment airline tickets.
83
83
  attr_accessor :process_identifier
84
84
 
85
85
  # Date on which the transaction occurred. Format: `YYYYMMDD` Format: English characters only. Optional request field.
@@ -17,7 +17,7 @@ module CyberSource
17
17
  # Ticket number, which consists of the carrier code, form, and serial number, without the check digit. **Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only. Optional field for ancillary services.
18
18
  attr_accessor :ticket_number
19
19
 
20
- # Name of the passenger. If the passengers name is not available, this value is the cardholders name. If neither the passengers name nor the cardholders name is available, this value is a description of the ancillary purchase. **Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only. Optional field for ancillary service.
20
+ # Name of the passenger. If the passenger's name is not available, this value is the cardholder's name. If neither the passenger's name nor the cardholder's name is available, this value is a description of the ancillary purchase. **Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only. Optional field for ancillary service.
21
21
  attr_accessor :passenger_name
22
22
 
23
23
  # Number for the airline ticket to which the ancillary purchase is connected. If this purchase has a connection or relationship to another purchase such as a baggage fee for a passenger transport ticket, this field must contain the ticket number for the other purchase. For a stand-alone purchase, the value for this field must be the same as the value for the `travelInformation.transit.airline.ancillaryInformation.ticketNumber` field. **Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only. Optional request field for ancillary services.
@@ -26,7 +26,7 @@ module CyberSource
26
26
  # IATA code for the class of service for this leg of the trip. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
27
27
  attr_accessor :_class
28
28
 
29
- # Code that indicates whether a stopover is allowed on this leg of the trip. Possible values: - `O` (capital letter O) (default): Stopover allowed - `X` (capital letter X): Stopover not allowed Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
29
+ # Code that indicates whether a stopover is allowed on this leg of the trip. Possible values: - `O` (capital letter \"O\") (default): Stopover allowed - `X` (capital letter \"X\"): Stopover not allowed Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
30
30
  attr_accessor :stopover_indicator
31
31
 
32
32
  # Departure date for the first leg of the trip. Format: `YYYYMMDD`. Format: English characters only. Optional request field for travel legs.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsWatchlistScreeningInformation
17
- # Parts of the customers information that must match with an entry in the DPL (denied parties list) before a match occurs. This field can contain one of the following values: - AND: (default) The customers name or company and the customers address must appear in the database. - OR: The customers name must appear in the database. - IGNORE: You want the service to detect a match only of the customers name or company but not of the address.
17
+ # Parts of the customer's information that must match with an entry in the DPL (denied parties list) before a match occurs. This field can contain one of the following values: - AND: (default) The customer's name or company and the customer's address must appear in the database. - OR: The customer's name must appear in the database. - IGNORE: You want the service to detect a match only of the customer's name or company but not of the address.
18
18
  attr_accessor :address_operator
19
19
 
20
20
  attr_accessor :weights
@@ -14,13 +14,13 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsWatchlistScreeningInformationWeights
17
- # Degree of correlation between a customers address and an entry in the DPL before a match occurs. This field can contain one of the following values: - exact: The address must be identical to the entry in the DPL. - high: (default) The address cannot differ significantly from the entry in the DPL. - medium: The address can differ slightly more from the entry in the DPL. - low: The address can differ significantly from the entry in the DPL.
17
+ # Degree of correlation between a customer's address and an entry in the DPL before a match occurs. This field can contain one of the following values: - exact: The address must be identical to the entry in the DPL. - high: (default) The address cannot differ significantly from the entry in the DPL. - medium: The address can differ slightly more from the entry in the DPL. - low: The address can differ significantly from the entry in the DPL.
18
18
  attr_accessor :address
19
19
 
20
20
  # Degree of correlation between a company address and an entry in the DPL before a match occurs. This field can contain one of the following values: - exact: The company name must be identical to the entry in the DPL. - high: (default) The company name cannot differ significantly from the entry in the DPL. - medium: The company name can differ slightly more from the entry in the DPL. - low: The company name can differ significantly from the entry in the DPL.
21
21
  attr_accessor :company
22
22
 
23
- # Degree of correlation between a customers name and an entry in the DPL before a match occurs. This field can contain one of the following values: - exact: The name must be identical to the entry in the DPL. - high: (default) The name cannot differ significantly from the entry in the DPL. - medium: The name can differ slightly more from the entry in the DPL. - low: The name can differ significantly the entry in the DPL.
23
+ # Degree of correlation between a customer's name and an entry in the DPL before a match occurs. This field can contain one of the following values: - exact: The name must be identical to the entry in the DPL. - high: (default) The name cannot differ significantly from the entry in the DPL. - medium: The name can differ slightly more from the entry in the DPL. - low: The name can differ significantly the entry in the DPL.
24
24
  attr_accessor :name
25
25
 
26
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidClientReferenceInformationPartner
17
- # Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminals software and to CyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminals software. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field.
17
+ # Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal's software and to CyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal's software. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field.
18
18
  attr_accessor :original_transaction_id
19
19
 
20
20
  # Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.
@@ -14,28 +14,28 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidcapturesAggregatorInformationSubMerchant
17
- # Sub-merchants 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.
17
+ # 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.
18
18
  attr_accessor :name
19
19
 
20
- # First line of the sub-merchants 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.
20
+ # 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.
21
21
  attr_accessor :address1
22
22
 
23
- # Sub-merchants 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.
23
+ # 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.
24
24
  attr_accessor :locality
25
25
 
26
- # Sub-merchants 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.
26
+ # 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.
27
27
  attr_accessor :administrative_area
28
28
 
29
- # Partial postal code for the sub-merchants 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.
29
+ # 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.
30
30
  attr_accessor :postal_code
31
31
 
32
- # Sub-merchants 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/)
32
+ # 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/)
33
33
  attr_accessor :country
34
34
 
35
- # Sub-merchants 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 merchants acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.
35
+ # 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.
36
36
  attr_accessor :email
37
37
 
38
- # Sub-merchants 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`
38
+ # 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`
39
39
  attr_accessor :phone_number
40
40
 
41
41
  # 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: Mastercard 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 Mastercard: String (15) FDC Compass: String (20) FDC Nashville Global: String (14)
@@ -14,13 +14,13 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidcapturesBuyerInformation
17
- # Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customers 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)
17
+ # Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
18
18
  attr_accessor :merchant_customer_id
19
19
 
20
- # Customers government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
20
+ # Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
21
21
  attr_accessor :vat_registration_number
22
22
 
23
- # Recipients 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/)
23
+ # 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/)
24
24
  attr_accessor :date_of_birth
25
25
 
26
26
  # Customer's gender. Possible values are F (female), M (male),O (other).
@@ -20,7 +20,7 @@ module CyberSource
20
20
  # IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field.
21
21
  attr_accessor :ip_address
22
22
 
23
- # Customers browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser.
23
+ # Customer's browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser.
24
24
  attr_accessor :user_agent
25
25
 
26
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,16 +20,16 @@ module CyberSource
20
20
  # 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/)
21
21
  attr_accessor :frequency
22
22
 
23
- # #### 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 merchants 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)
23
+ # #### 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)
24
24
  attr_accessor :plan_type
25
25
 
26
- # 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 merchants acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.
26
+ # 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.
27
27
  attr_accessor :sequence
28
28
 
29
29
  # 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/)
30
30
  attr_accessor :total_amount
31
31
 
32
- # 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 merchants acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.
32
+ # 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.
33
33
  attr_accessor :total_count
34
34
 
35
35
  # 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
@@ -19,7 +19,7 @@ module CyberSource
19
19
  # 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)
20
20
  attr_accessor :card_acceptor_reference_number
21
21
 
22
- # 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 companys 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
22
+ # 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
23
23
  attr_accessor :category_code
24
24
 
25
25
  # 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)
@@ -69,7 +69,7 @@ module CyberSource
69
69
  # Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
70
70
  attr_accessor :original_currency
71
71
 
72
- # Cashback amount in the acquirers 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.
72
+ # 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.
73
73
  attr_accessor :cashback_amount
74
74
 
75
75
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,18 +17,18 @@ module CyberSource
17
17
  # Title.
18
18
  attr_accessor :title
19
19
 
20
- # Customers first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
20
+ # Customer's first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
21
21
  attr_accessor :first_name
22
22
 
23
- # Customers middle name.
23
+ # Customer's middle name.
24
24
  attr_accessor :middle_name
25
25
 
26
- # Customers last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
26
+ # Customer's last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
27
27
  attr_accessor :last_name
28
28
 
29
29
  attr_accessor :company
30
30
 
31
- # Payment card billing street address as it appears on the credit card issuers records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
31
+ # Payment card billing street address as it appears on the credit card issuer's records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
32
32
  attr_accessor :address1
33
33
 
34
34
  # Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate `orderInformation.billTo.address1` and `orderInformation.billTo.address2`, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60)
@@ -37,7 +37,7 @@ module CyberSource
37
37
  # Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
38
38
  attr_accessor :locality
39
39
 
40
- # Customers neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on **Cielo**.
40
+ # Customer's neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on **Cielo**.
41
41
  attr_accessor :district
42
42
 
43
43
  # 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.
@@ -55,7 +55,7 @@ module CyberSource
55
55
  # Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
56
56
  attr_accessor :email
57
57
 
58
- # Customers phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used.
58
+ # Customer's phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used.
59
59
  attr_accessor :phone_number
60
60
 
61
61
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -29,7 +29,7 @@ module CyberSource
29
29
  # 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)
30
30
  attr_accessor :vat_invoice_reference_number
31
31
 
32
- # International description code of the overall orders 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)
32
+ # 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)
33
33
  attr_accessor :commodity_code
34
34
 
35
35
  attr_accessor :transaction_advice_addendum
@@ -14,13 +14,13 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidcapturesOrderInformationShipTo
17
- # State or province of the shipping 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) (maximum length: 2) 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 cardholders location when shipTo objects are not present.
17
+ # State or province of the shipping 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) (maximum length: 2) 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.
18
18
  attr_accessor :administrative_area
19
19
 
20
- # 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 cardholders location when shipTo objects are not present.
20
+ # 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.
21
21
  attr_accessor :country
22
22
 
23
- # 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 cardholders location when shipTo objects are not present.
23
+ # 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.
24
24
  attr_accessor :postal_code
25
25
 
26
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidcapturesPointOfSaleInformationEmv
17
- # EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For information about the individual tags, see the Application Specification section in the EMV 4.3 Specifications: http://emvco.com **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Important** The following tags contain sensitive information and **must not** be included in this field: - `56`: Track 1 equivalent data - `57`: Track 2 equivalent data - `5A`: Application PAN - `5F20`: Cardholder name - `5F24`: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX) - `99`: Transaction PIN - `9F0B`: Cardholder name (extended) - `9F1F`: Track 1 discretionary data - `9F20`: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - `95`: Terminal verification results - `9F10`: Issuer application data - `9F26`: Application cryptogram #### CyberSource through VisaNet - In Japan: 199 bytes - In other countries: String (252) #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### JCN Gateway The following tags must be included: - `4F`: Application identifier - `84`: Dedicated file name Data length: 199 bytes #### All other processors: String (999) #### Used by Authorization: Optional Authorization Reversal: Optional Credit: Optional PIN Debit processing (purchase, credit and reversal): Optional
17
+ # EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Important** The following tags contain sensitive information and **must not** be included in this field: - `56`: Track 1 equivalent data - `57`: Track 2 equivalent data - `5A`: Application PAN - `5F20`: Cardholder name - `5F24`: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX) - `99`: Transaction PIN - `9F0B`: Cardholder name (extended) - `9F1F`: Track 1 discretionary data - `9F20`: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - `95`: Terminal verification results - `9F10`: Issuer application data - `9F26`: Application cryptogram #### CyberSource through VisaNet - In Japan: 199 bytes - In other countries: String (252) #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### JCN Gateway The following tags must be included: - `4F`: Application identifier - `84`: Dedicated file name Data length: 199 bytes #### All other processors: String (999) #### Used by Authorization: Optional Authorization Reversal: Optional Credit: Optional PIN Debit processing (purchase, credit and reversal): Optional
18
18
  attr_accessor :tags
19
19
 
20
20
  # Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - `true`: Fallback method was used. - `false` (default): Fallback method was not used. This field is supported only on American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet, FDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX.
@@ -16,7 +16,7 @@ module CyberSource
16
16
  class Ptsv2paymentsidrefundsMerchantInformation
17
17
  attr_accessor :merchant_descriptor
18
18
 
19
- # 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 companys 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
19
+ # 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
20
20
  attr_accessor :category_code
21
21
 
22
22
  # 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)
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidrefundsOrderInformationLineItems
17
- # 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 dont 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 youve indicated you need to collect tax [by way of nexus, no nexus, or seller registration number fields].
17
+ # 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].
18
18
  attr_accessor :product_code
19
19
 
20
20
  # 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.
@@ -22,7 +22,7 @@ module CyberSource
22
22
  # International Bank Account Number (IBAN) for the bank account. For some countries you can provide this number instead of the traditional bank account information. You can use this field only when scoring a direct debit transaction. For all possible values, see the `bank_iban` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
23
23
  attr_accessor :iban
24
24
 
25
- # Banks SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
25
+ # Bank's SWIFT code. You can use this field only when scoring a direct debit transaction. Required only for crossborder transactions. For all possible values, see the `bank_swiftcode` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
26
26
  attr_accessor :swift_code
27
27
 
28
28
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidrefundsPaymentInformationCard
17
- # The customers 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.
17
+ # 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.
18
18
  attr_accessor :number
19
19
 
20
20
  # Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### 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 (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### 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. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response.
@@ -26,7 +26,7 @@ module CyberSource
26
26
  # 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
27
27
  attr_accessor :type
28
28
 
29
- # Identifier for the issuing bank that provided the customers encoded account number. Contact your processor for the banks ID.
29
+ # Identifier for the issuing bank that provided the customer's encoded account number. Contact your processor for the bank's ID.
30
30
  attr_accessor :account_encoder_id
31
31
 
32
32
  # Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidreversalsPointOfSaleInformationEmv
17
- # EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For information about the individual tags, see the Application Specification section in the EMV 4.3 Specifications: http://emvco.com **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Important** The following tags contain sensitive information and **must not** be included in this field: - `56`: Track 1 equivalent data - `57`: Track 2 equivalent data - `5A`: Application PAN - `5F20`: Cardholder name - `5F24`: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX) - `99`: Transaction PIN - `9F0B`: Cardholder name (extended) - `9F1F`: Track 1 discretionary data - `9F20`: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - `95`: Terminal verification results - `9F10`: Issuer application data - `9F26`: Application cryptogram #### CyberSource through VisaNet - In Japan: 199 bytes - In other countries: String (252) #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### JCN Gateway The following tags must be included: - `4F`: Application identifier - `84`: Dedicated file name Data length: 199 bytes #### All other processors: String (999) #### Used by Authorization: Optional Authorization Reversal: Optional Credit: Optional PIN Debit processing (purchase, credit and reversal): Optional
17
+ # EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For information about the individual tags, see the \"Application Specification\" section in the EMV 4.3 Specifications: http://emvco.com **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Important** The following tags contain sensitive information and **must not** be included in this field: - `56`: Track 1 equivalent data - `57`: Track 2 equivalent data - `5A`: Application PAN - `5F20`: Cardholder name - `5F24`: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX) - `99`: Transaction PIN - `9F0B`: Cardholder name (extended) - `9F1F`: Track 1 discretionary data - `9F20`: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - `95`: Terminal verification results - `9F10`: Issuer application data - `9F26`: Application cryptogram #### CyberSource through VisaNet - In Japan: 199 bytes - In other countries: String (252) #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### JCN Gateway The following tags must be included: - `4F`: Application identifier - `84`: Dedicated file name Data length: 199 bytes #### All other processors: String (999) #### Used by Authorization: Optional Authorization Reversal: Optional Credit: Optional PIN Debit processing (purchase, credit and reversal): Optional
18
18
  attr_accessor :tags
19
19
 
20
20
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2payoutsMerchantInformation
17
- # 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 companys 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
17
+ # 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
18
18
  attr_accessor :category_code
19
19
 
20
20
  # Time that the transaction was submitted in local time. The time is in hhmmss format.