cybersource_rest_client 0.0.13 → 0.0.14

Sign up to get free protection for your applications and to get access to all the features.
Files changed (264) hide show
  1. checksums.yaml +4 -4
  2. data/lib/cybersource_rest_client/api/download_dtd_api.rb +88 -0
  3. data/lib/cybersource_rest_client/api/download_xsd_api.rb +88 -0
  4. data/lib/cybersource_rest_client/api/instrument_identifier_api.rb +2 -2
  5. data/lib/cybersource_rest_client/api/payer_authentication_api.rb +154 -0
  6. data/lib/cybersource_rest_client/api/reversal_api.rb +0 -65
  7. data/lib/cybersource_rest_client/api/search_transactions_api.rb +2 -2
  8. data/lib/cybersource_rest_client/api/transaction_batches_api.rb +2 -76
  9. data/lib/cybersource_rest_client/api/user_management_api.rb +2 -2
  10. data/lib/cybersource_rest_client/api/void_api.rb +0 -65
  11. data/lib/cybersource_rest_client/models/{mit_void_request.rb → authorization_options.rb} +8 -8
  12. data/lib/cybersource_rest_client/models/bill_to.rb +467 -0
  13. data/lib/cybersource_rest_client/models/buyer_information.rb +278 -0
  14. data/lib/cybersource_rest_client/models/card_info.rb +224 -0
  15. data/lib/cybersource_rest_client/models/check_payer_auth_enrollment_request.rb +275 -0
  16. data/lib/cybersource_rest_client/models/der_public_key.rb +205 -0
  17. data/lib/cybersource_rest_client/models/detail.rb +194 -0
  18. data/lib/cybersource_rest_client/models/embedded_instrument_identifier.rb +319 -0
  19. data/lib/cybersource_rest_client/models/error.rb +202 -0
  20. data/lib/cybersource_rest_client/models/error_bean.rb +247 -0
  21. data/lib/cybersource_rest_client/models/error_field_bean.rb +205 -0
  22. data/lib/cybersource_rest_client/models/{inline_response_200.rb → error_links.rb} +24 -22
  23. data/lib/cybersource_rest_client/models/error_response.rb +174 -0
  24. data/lib/cybersource_rest_client/models/error_response_with_hal.rb +174 -0
  25. data/lib/cybersource_rest_client/models/existing_instrument_identifier_id.rb +175 -0
  26. data/lib/cybersource_rest_client/models/file_bean.rb +202 -0
  27. data/lib/cybersource_rest_client/models/file_detail.rb +278 -0
  28. data/lib/cybersource_rest_client/models/file_details_response.rb +194 -0
  29. data/lib/cybersource_rest_client/models/initiator.rb +183 -0
  30. data/lib/cybersource_rest_client/models/instrument_identifier.rb +295 -0
  31. data/lib/cybersource_rest_client/models/instrument_identifier_bank_account.rb +242 -0
  32. data/lib/cybersource_rest_client/models/instrument_identifier_card.rb +208 -0
  33. data/lib/cybersource_rest_client/models/instrument_identifier_enrollable_card.rb +202 -0
  34. data/lib/cybersource_rest_client/models/instrument_identifier_processing_information.rb +183 -0
  35. data/lib/cybersource_rest_client/models/instrument_identifier_update.rb +183 -0
  36. data/lib/cybersource_rest_client/models/json_web_key.rb +225 -0
  37. data/lib/cybersource_rest_client/models/key_parameters.rb +189 -0
  38. data/lib/cybersource_rest_client/models/key_result.rb +202 -0
  39. data/lib/cybersource_rest_client/models/link.rb +183 -0
  40. data/lib/cybersource_rest_client/models/links.rb +201 -0
  41. data/lib/cybersource_rest_client/models/merchant_information.rb +183 -0
  42. data/lib/cybersource_rest_client/models/merchant_initiated_transaction.rb +199 -0
  43. data/lib/cybersource_rest_client/models/metadata.rb +184 -0
  44. data/lib/cybersource_rest_client/models/model_409_link.rb +183 -0
  45. data/lib/cybersource_rest_client/models/model_409_links.rb +183 -0
  46. data/lib/cybersource_rest_client/models/payment_instrument.rb +331 -0
  47. data/lib/cybersource_rest_client/models/payment_instrument_bank_account.rb +218 -0
  48. data/lib/cybersource_rest_client/models/payment_instrument_card.rb +403 -0
  49. data/lib/cybersource_rest_client/models/payment_instrument_for_instrument_identifier_links.rb +219 -0
  50. data/lib/cybersource_rest_client/models/payment_instruments_array.rb +175 -0
  51. data/lib/cybersource_rest_client/models/payment_instruments_for_instrument_identifier.rb +276 -0
  52. data/lib/cybersource_rest_client/models/personal_identification.rb +237 -0
  53. data/lib/cybersource_rest_client/models/personal_identification_array.rb +174 -0
  54. data/lib/cybersource_rest_client/models/pi_for_ii_link_first.rb +184 -0
  55. data/lib/cybersource_rest_client/models/pi_for_ii_link_last.rb +184 -0
  56. data/lib/cybersource_rest_client/models/pi_for_ii_link_next.rb +184 -0
  57. data/lib/cybersource_rest_client/models/pi_for_ii_link_prev.rb +184 -0
  58. data/lib/cybersource_rest_client/models/pi_for_ii_link_self.rb +184 -0
  59. data/lib/cybersource_rest_client/models/processing_information.rb +195 -0
  60. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response_credit_amount_details.rb +1 -1
  61. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response_processing_information_bank_transfer_options.rb +1 -1
  62. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post201_response_order_information_amount_details.rb +1 -1
  63. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_client_reference_information.rb +2 -2
  64. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_error_information.rb +3 -3
  65. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb +15 -15
  66. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_issuer_information.rb +2 -2
  67. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_amount_details.rb +1 -1
  68. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_invoice_details.rb +1 -1
  69. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb +13 -13
  70. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_bank_account.rb +1 -1
  71. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_card.rb +1 -1
  72. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb +7 -7
  73. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb +1 -1
  74. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information_emv.rb +1 -1
  75. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processing_information_bank_transfer_options.rb +2 -2
  76. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information.rb +9 -9
  77. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_ach_verification.rb +2 -2
  78. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_card_verification.rb +2 -2
  79. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_consumer_authentication_response.rb +2 -2
  80. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_customer.rb +1 -1
  81. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_electronic_verification_results.rb +5 -5
  82. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_merchant_advice.rb +2 -2
  83. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_routing.rb +3 -3
  84. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb +1 -1
  85. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_refund_amount_details.rb +1 -1
  86. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post400_response.rb +2 -2
  87. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb +4 -4
  88. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_reversal_amount_details.rb +3 -3
  89. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post400_response.rb +2 -2
  90. data/lib/cybersource_rest_client/models/pts_v2_payments_voids_post201_response_void_amount_details.rb +1 -1
  91. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb +0 -6
  92. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_merchant_information_merchant_descriptor.rb +3 -3
  93. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_order_information_amount_details.rb +2 -2
  94. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_processor_information.rb +1 -1
  95. data/lib/cybersource_rest_client/models/pts_v2_payouts_post400_response.rb +0 -24
  96. data/lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information.rb +1 -1
  97. data/lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb +2 -2
  98. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb +4 -4
  99. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb +3 -3
  100. data/lib/cybersource_rest_client/models/ptsv2payments_aggregator_information.rb +1 -1
  101. data/lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb +2 -2
  102. data/lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb +4 -4
  103. data/lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb +3 -3
  104. data/lib/cybersource_rest_client/models/ptsv2payments_client_reference_information.rb +2 -2
  105. data/lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb +2 -2
  106. data/lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb +1 -1
  107. data/lib/cybersource_rest_client/models/ptsv2payments_device_information.rb +3 -3
  108. data/lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb +10 -10
  109. data/lib/cybersource_rest_client/models/ptsv2payments_issuer_information.rb +1 -1
  110. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb +2 -2
  111. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb +7 -7
  112. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb +8 -8
  113. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_initiated_transaction.rb +1 -1
  114. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb +7 -7
  115. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_amex_additional_amounts.rb +1 -1
  116. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb +9 -9
  117. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb +62 -12
  118. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to_company.rb +3 -3
  119. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb +8 -8
  120. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb +6 -6
  121. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_shipping_details.rb +2 -17
  122. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb +8 -8
  123. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_customer.rb +1 -1
  124. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb +3 -3
  125. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb +7 -7
  126. data/lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb +9 -9
  127. data/lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information_emv.rb +3 -3
  128. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information.rb +4 -4
  129. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb +8 -8
  130. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options_initiator.rb +2 -2
  131. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb +6 -6
  132. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb +2 -2
  133. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_recurring_options.rb +2 -2
  134. data/lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb +3 -3
  135. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_aggregator_information.rb +1 -1
  136. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_aggregator_information_sub_merchant.rb +2 -2
  137. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_buyer_information.rb +1 -1
  138. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb +18 -18
  139. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb +4 -4
  140. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb +6 -6
  141. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_bill_to.rb +10 -10
  142. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_invoice_details.rb +6 -6
  143. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_point_of_sale_information.rb +1 -1
  144. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_point_of_sale_information_emv.rb +1 -1
  145. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information.rb +4 -4
  146. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb +3 -3
  147. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_capture_options.rb +2 -2
  148. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_merchant_information.rb +4 -4
  149. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_order_information_line_items.rb +6 -6
  150. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_card.rb +4 -4
  151. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb +4 -4
  152. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information_recurring_options.rb +1 -1
  153. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb +1 -1
  154. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information_partner.rb +2 -2
  155. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_order_information_line_items.rb +2 -2
  156. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_processing_information.rb +4 -4
  157. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_reversal_information.rb +1 -1
  158. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_reversal_information_amount_details.rb +2 -2
  159. data/lib/cybersource_rest_client/models/ptsv2payouts_client_reference_information.rb +1 -1
  160. data/lib/cybersource_rest_client/models/ptsv2payouts_merchant_information.rb +2 -26
  161. data/lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb +6 -6
  162. data/lib/cybersource_rest_client/models/ptsv2payouts_order_information_amount_details.rb +2 -2
  163. data/lib/cybersource_rest_client/models/ptsv2payouts_order_information_bill_to.rb +10 -10
  164. data/lib/cybersource_rest_client/models/ptsv2payouts_payment_information_card.rb +5 -5
  165. data/lib/cybersource_rest_client/models/ptsv2payouts_processing_information.rb +1 -1
  166. data/lib/cybersource_rest_client/models/{mit_reversal_request.rb → request.rb} +19 -28
  167. data/lib/cybersource_rest_client/models/response_status.rb +225 -0
  168. data/lib/cybersource_rest_client/models/response_status_details.rb +194 -0
  169. data/lib/cybersource_rest_client/models/risk_v1_authentication_results_post201_response.rb +285 -0
  170. data/lib/cybersource_rest_client/models/risk_v1_authentication_results_post201_response_consumer_authentication_information.rb +324 -0
  171. data/lib/cybersource_rest_client/models/risk_v1_authentications_post201_response.rb +294 -0
  172. data/lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_consumer_authentication_information.rb +429 -0
  173. data/lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_order_information.rb +183 -0
  174. data/lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_order_information_amount_details.rb +199 -0
  175. data/lib/cybersource_rest_client/models/risk_v1_authentications_post400_response.rb +225 -0
  176. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response.rb +10 -1
  177. data/lib/cybersource_rest_client/models/{risk_v1_decisions_post201_response_risk_information_payment_information.rb → risk_v1_decisions_post201_response_payment_information.rb} +6 -6
  178. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information.rb +15 -15
  179. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_info_codes.rb +8 -8
  180. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_ip_address.rb +34 -34
  181. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_profile.rb +1 -1
  182. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_providers_provider_name.rb +1 -1
  183. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_score.rb +2 -2
  184. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_travel.rb +210 -0
  185. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_travel_actual_final_destination.rb +274 -0
  186. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_travel_first_departure.rb +274 -0
  187. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_travel_first_destination.rb +274 -0
  188. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_travel_last_destination.rb +274 -0
  189. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_velocity.rb +1 -0
  190. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_risk_information_velocity_morphing.rb +3 -3
  191. data/lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb +214 -0
  192. data/lib/cybersource_rest_client/models/riskv1authenticationresults_order_information.rb +194 -0
  193. data/lib/cybersource_rest_client/models/riskv1authenticationresults_order_information_line_items.rb +267 -0
  194. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information.rb +192 -0
  195. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information_card.rb +264 -0
  196. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information_tokenized_card.rb +264 -0
  197. data/lib/cybersource_rest_client/models/riskv1authentications_buyer_information.rb +196 -0
  198. data/lib/cybersource_rest_client/models/riskv1authentications_client_reference_information.rb +208 -0
  199. data/lib/cybersource_rest_client/models/riskv1authentications_consumer_authentication_information.rb +552 -0
  200. data/lib/cybersource_rest_client/models/riskv1authentications_device_information.rb +285 -0
  201. data/lib/cybersource_rest_client/models/riskv1authentications_device_information_raw_data.rb +209 -0
  202. data/lib/cybersource_rest_client/models/{inline_response_200_payment_batch_summaries.rb → riskv1authentications_merchant_information.rb} +18 -101
  203. data/lib/cybersource_rest_client/models/riskv1authentications_order_information.rb +258 -0
  204. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_bill_to.rb +496 -0
  205. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb +371 -0
  206. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_ship_to.rb +434 -0
  207. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information.rb +192 -0
  208. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_card.rb +291 -0
  209. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_tokenized_card.rb +291 -0
  210. data/lib/cybersource_rest_client/models/riskv1authentications_recurring_payment_information.rb +235 -0
  211. data/lib/cybersource_rest_client/models/riskv1authentications_risk_information.rb +183 -0
  212. data/lib/cybersource_rest_client/models/riskv1authentications_risk_information_buyer_history.rb +262 -0
  213. data/lib/cybersource_rest_client/models/riskv1authentications_risk_information_buyer_history_account_history.rb +209 -0
  214. data/lib/cybersource_rest_client/models/riskv1authentications_risk_information_buyer_history_customer_account.rb +279 -0
  215. data/lib/cybersource_rest_client/models/riskv1authentications_travel_information.rb +206 -0
  216. data/lib/cybersource_rest_client/models/riskv1authentications_travel_information_legs.rb +259 -0
  217. data/lib/cybersource_rest_client/models/riskv1authentications_travel_information_passengers.rb +224 -0
  218. data/lib/cybersource_rest_client/models/riskv1decisions_buyer_information.rb +28 -3
  219. data/lib/cybersource_rest_client/models/riskv1decisions_card_verification.rb +1 -1
  220. data/lib/cybersource_rest_client/models/riskv1decisions_client_reference_information.rb +1 -1
  221. data/lib/cybersource_rest_client/models/riskv1decisions_device_information.rb +5 -5
  222. data/lib/cybersource_rest_client/models/riskv1decisions_merchant_defined_information.rb +1 -1
  223. data/lib/cybersource_rest_client/models/riskv1decisions_order_information.rb +2 -17
  224. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_amount_details.rb +2 -2
  225. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_bill_to.rb +10 -10
  226. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb +5 -22
  227. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_passenger.rb +30 -5
  228. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_shipping_details.rb +2 -17
  229. data/lib/cybersource_rest_client/models/riskv1decisions_payment_information_card.rb +4 -4
  230. data/lib/cybersource_rest_client/models/riskv1decisions_payment_information_tokenized_card.rb +3 -3
  231. data/lib/cybersource_rest_client/models/riskv1decisions_risk_information.rb +29 -4
  232. data/lib/cybersource_rest_client/models/riskv1decisions_risk_information_profile.rb +1 -1
  233. data/lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb +26 -1
  234. data/lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb +31 -6
  235. data/lib/cybersource_rest_client/models/self_link_bean.rb +192 -0
  236. data/lib/cybersource_rest_client/models/tokenize_parameters.rb +198 -0
  237. data/lib/cybersource_rest_client/models/tokenize_request.rb +1 -1
  238. data/lib/cybersource_rest_client/models/tokenize_result.rb +255 -0
  239. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_application_information_applications.rb +6 -6
  240. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_buyer_information.rb +2 -2
  241. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb +1 -1
  242. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_device_information.rb +3 -3
  243. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_merchant_information_merchant_descriptor.rb +1 -1
  244. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_amount_details.rb +2 -2
  245. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb +9 -9
  246. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb +1 -1
  247. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_shipping_details.rb +2 -17
  248. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_account_features.rb +1 -1
  249. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb +5 -5
  250. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_point_of_sale_information.rb +2 -2
  251. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb +1 -1
  252. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information_authorization_options.rb +1 -1
  253. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb +3 -3
  254. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information_electronic_verification_results.rb +4 -4
  255. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_buyer_information.rb +1 -1
  256. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_client_reference_information.rb +1 -1
  257. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_device_information.rb +1 -1
  258. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_order_information_bill_to.rb +5 -5
  259. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_payment_information_card.rb +2 -2
  260. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_point_of_sale_information.rb +2 -2
  261. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_processing_information.rb +1 -1
  262. data/lib/cybersource_rest_client.rb +96 -8
  263. metadata +100 -8
  264. data/lib/cybersource_rest_client/api/payment_batch_summaries_api.rb +0 -135
@@ -17,7 +17,7 @@ module CyberSource
17
17
  # Payment related information. This information is included on the customer’s statement.
18
18
  attr_accessor :customer_memo
19
19
 
20
- # Authorization method used for the transaction. See \"SEC Codes,\" page 89. TeleCheck Accepts only the following values: - **PPD** - **TEL** - **WEB**
20
+ # Authorization method used for the transaction. #### TeleCheck Accepts only the following values: - `PPD` - `TEL` - `WEB` For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
21
21
  attr_accessor :sec_code
22
22
 
23
23
  # City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters.
@@ -29,10 +29,10 @@ module CyberSource
29
29
  # Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not include this value, CyberSource sets the effective date to the next business day. Format: `MMDDYYYY` Supported only for the CyberSource ACH Service.
30
30
  attr_accessor :effective_date
31
31
 
32
- # Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. See \"Multiple Partial Credits,\" page 41.
32
+ # Identifier for a partial payment or partial credit. The value for each debit request or credit request must be unique within the scope of the order. For details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
33
33
  attr_accessor :partial_payment_id
34
34
 
35
- # Method used for settlement. Possible values: - **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars) - **F**: Facsimile draft (U.S. dollars only) - **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) See \"Settlement Delivery Methods,\" page 44.
35
+ # Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
36
36
  attr_accessor :settlement_method
37
37
 
38
38
  # 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 Ptsv2paymentsAggregatorInformation
17
- # Value that identifies you as a payment aggregator. Get this value from the processor. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. ccAuthService\\ **American Express Direct**: R for all aggregator transactions.\\ **CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\ **FDC Compass**: R for all aggregator transactions.\\ **FDC Nashville Global**: R for all aggregator transactions. For processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
17
+ # Value that identifies you as a payment aggregator. Get this value from the processor. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. ccAuthService\\ **American Express Direct**: R for all aggregator transactions.\\ **CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\ **FDC Compass**: R for all aggregator transactions.\\ **FDC Nashville Global**: R for all aggregator transactions. For processor-specific information, see the `aggregator_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
18
18
  attr_accessor :aggregator_id
19
19
 
20
20
  # Your payment aggregator business name. **American Express Direct**\\ The maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\ **CyberSource through VisaNet**\\ With American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5. **FDC Compass**\\ This value must consist of uppercase characters. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
@@ -20,10 +20,10 @@ module CyberSource
20
20
  # 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.
21
21
  attr_accessor :name
22
22
 
23
- # First line of the sub-merchant’s street address. See \"Aggregator Support,\" page 100. **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
+ # 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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 :address1
25
25
 
26
- # Sub-merchant’s city. **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 \"Aggregator Support,\" page 100.
26
+ # Sub-merchant’s city. For processor-specific details, see `submerchant_city` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 :locality
28
28
 
29
29
  # Sub-merchant’s state or province. Use the State, Province, and Territory Codes for the United States and Canada. See \"Aggregator Support,\" page 100. **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.
@@ -14,21 +14,21 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsBuyerInformation
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. **Litle**\\ For a follow-on credit with Litle, 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 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
- # 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 \"Recipients,\" page 224.
20
+ # 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/wwhelp/wwhimpl/js/html/wwhelp.htm)
21
21
  attr_accessor :date_of_birth
22
22
 
23
23
  # Customer’s government-assigned tax identification number. 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)
24
24
  attr_accessor :vat_registration_number
25
25
 
26
- # Company’s tax identifier. This is only used for eCheck service. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used
26
+ # Company’s tax identifier. This is only used for eCheck service. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used.
27
27
  attr_accessor :company_tax_id
28
28
 
29
29
  attr_accessor :personal_identification
30
30
 
31
- # The description for this field is not available.
31
+ # The merchant's password that CyberSource hashes and stores as a hashed password. For details about this field, see the `customer_password` field description in [Decision Manager Developer Guide Using the SCMP API.](https://www.cybersource.com/developers/documentation/fraud_management/)
32
32
  attr_accessor :hashed_password
33
33
 
34
34
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,13 +14,13 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsBuyerInformationPersonalIdentification
17
- # The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` This field is supported only on the following processors. **ComercioLatino**\\ Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing**\\ Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting.
17
+ # The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.
18
18
  attr_accessor :type
19
19
 
20
- # The value of the identification type. This field is supported only on the following processors. **ComercioLatino** Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing** Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the personal_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If type = PASSPORT, this is the cardholder's passport number. Recommended for Discover ProtectBuy.
20
+ # The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy.
21
21
  attr_accessor :id
22
22
 
23
- # If type = DRIVER_LICENSE, this is the State or province where the customer’s driver’s license was issued. Use the two-character State, Province, and Territory Codes for the United States and Canada. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. If type = PASSPORT, this is the Issuing country for the cardholder’s passport. Recommended for Discover ProtectBuy.
23
+ # The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer’s driver’s license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder’s passport. Recommended for Discover ProtectBuy. Use the two-character State, Province, and Territory Codes for the United States and Canada. #### TeleCheck Contact your TeleCheck representative to find out whether this field is required or optional. #### All Other Processors Not used. For details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
24
24
  attr_accessor :issued_by
25
25
 
26
26
  class EnumAttributeValidator
@@ -14,10 +14,10 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsClientReferenceInformation
17
- # Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
17
+ # Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
18
18
  attr_accessor :code
19
19
 
20
- # Identifier that you assign to the transaction. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. See page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)
20
+ # Identifier that you assign to the transaction. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. For details, see \"Merchant-Initiated Reversals and Voids\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
21
21
  attr_accessor :transaction_id
22
22
 
23
23
  # Comments
@@ -17,10 +17,10 @@ module CyberSource
17
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 American Express Direct, FDC Nashville Global, and SIX.
18
18
  attr_accessor :original_transaction_id
19
19
 
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.
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.
21
21
  attr_accessor :developer_id
22
22
 
23
- # Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. Note When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.
23
+ # Identifier for the partner that is integrated to CyberSource. Send this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner. **Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.
24
24
  attr_accessor :solution_id
25
25
 
26
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,7 +17,7 @@ module CyberSource
17
17
  # Cardholder authentication verification value (CAVV).
18
18
  attr_accessor :cavv
19
19
 
20
- # Algorithm used to generate the CAVV for Verified by Visa or the UCAF authentication data for Mastercard Identity Check.
20
+ # Algorithm used to generate the CAVV for Visa Secure or the UCAF authentication data for Mastercard Identity Check.
21
21
  attr_accessor :cavv_algorithm
22
22
 
23
23
  # Raw electronic commerce indicator (ECI). For the description and requirements, see \"Payer Authentication,\" page 180.
@@ -14,13 +14,13 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsDeviceInformation
17
- # Host name reported by the customer’s browser to your Web server identified via the HTTP header.
17
+ # DNS resolved hostname from `ipAddress`.
18
18
  attr_accessor :host_name
19
19
 
20
- # Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information.
20
+ # IP address of the customer.
21
21
  attr_accessor :ip_address
22
22
 
23
- # Customer’s 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.
@@ -14,34 +14,34 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsInstallmentInformation
17
- # Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. See \"Installment Payments,\" page 127.
17
+ # Amount for the current installment payment. This field is supported only for CyberSource through VisaNet. For details, see `installment_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
18
18
  attr_accessor :amount
19
19
 
20
- # Installment Frequency of the installment payments. This field is supported only for CyberSource through VisaNet. Possible values: - B: Biweekly - M: Monthly - W: Weekly See \"Installment Payments,\" page 127.
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/wwhelp/wwhimpl/js/html/wwhelp.htm) 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/wwhelp/wwhimpl/js/html/wwhelp.htm)
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. See \"Installment Payments,\" page 136. **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 See \"Installment Payments,\" page 125. 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 See \"Installment Payments on CyberSource through VisaNet,\" page 142. 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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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/wwhelp/wwhimpl/js/html/wwhelp.htm) 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. See \"Installment Payments,\" page 125. **Chase Paymentech Solutions and FDC Compass**\\ This field is optional because this value is required in the merchant descriptors. See \"Chase Paymentech Solutions Merchant Descriptors,\" page 142, and \"FDC Compass Merchant Descriptors,\" page 153. **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.
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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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
- # Total amount of the loan that is being paid in installments. This field is supported only for CyberSource through VisaNet. See \"Installment Payments,\" page 127.
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/wwhelp/wwhimpl/js/html/wwhelp.htm)
30
30
  attr_accessor :total_amount
31
31
 
32
- # Total number of installments when making payments in installments. See \"Installment Payments,\" page 127. **Chase Paymentech Solutions and FDC Compass**\\ This field is optional because this value is required in the merchant descriptors. See \"Chase Paymentech Solutions Merchant Descriptors,\" page 144, and \"FDC Compass Merchant Descriptors,\" page 155. **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.
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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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
- # 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. See Installment Payments on CyberSource through VisaNet. 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 file5: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment
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/wwhelp/wwhimpl/js/html/wwhelp.htm) 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 file5: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment
36
36
  attr_accessor :first_installment_date
37
37
 
38
- # Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. See Installment Payments on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification
38
+ # Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification
39
39
  attr_accessor :invoice_data
40
40
 
41
- # Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. See Installment Payments on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information
41
+ # Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information
42
42
  attr_accessor :payment_type
43
43
 
44
- # Indicates whether the authorization request is a Crediario eligibility inquiry. See Installment Payments on CyberSource through VisaNet. Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.
44
+ # Indicates whether the authorization request is a Crediario eligibility inquiry. For details, see \"Installment Payments on CyberSource through VisaNet\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.
45
45
  attr_accessor :eligibility_inquiry
46
46
 
47
47
  # 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 Ptsv2paymentsIssuerInformation
17
- # Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.
17
+ # Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
18
18
  attr_accessor :discretionary_data
19
19
 
20
20
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,10 +14,10 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsMerchantDefinedInformation
17
- # The name you assign for your merchant-defined data field. **CyberSource through VisaNet**\\ For installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and merchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the transaction. See \"Installment Payments on CyberSource through VisaNet,\" page 142.
17
+ # The name you assign for your merchant-defined data field. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see \"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/wwhelp/wwhimpl/js/html/wwhelp.htm)
18
18
  attr_accessor :key
19
19
 
20
- # The value you assign for your merchant-defined data field. **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. **CyberSource through VisaNet**\\ For installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and merchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the transaction. See \"Installment Payments on CyberSource through VisaNet,\" page 142. For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3
20
+ # The value you assign for your merchant-defined data field. For details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3
21
21
  attr_accessor :value
22
22
 
23
23
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -16,25 +16,25 @@ module CyberSource
16
16
  class Ptsv2paymentsMerchantInformation
17
17
  attr_accessor :merchant_descriptor
18
18
 
19
- # Company ID assigned to an independent sales organization. Get this value from Mastercard. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the sales_organization_ID field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
19
+ # Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
20
20
  attr_accessor :sales_organization_id
21
21
 
22
- # Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If 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 in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) See \"Aggregator Support,\" page 100. **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
- # Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. Including this field in a request for a domestic transaction might reduce interchange fees. When you include this field in a request: - Do not include the merchantCategoryCode field. - The value for this field overrides the value in your CyberSource account. This field is supported only for: - Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country. - Merchants enrolled in the OmniPay Direct interchange program. - First Data Merchant Solutions (Europe) on OmniPay Direct.
25
+ # Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. Including this field in a request for a domestic transaction might reduce interchange fees. When you include this field in a request: - Do not include the `merchant_category_code` field. - The value for this field overrides the value in your CyberSource account. This field is supported only for: - Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country. - Merchants enrolled in the OmniPay Direct interchange program. - First Data Merchant Solutions (Europe) on OmniPay Direct.
26
26
  attr_accessor :category_code_domestic
27
27
 
28
- # Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1
28
+ # Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
29
29
  attr_accessor :tax_id
30
30
 
31
- # Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the merchant_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)
31
+ # Your government-assigned tax identification number. 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)
32
32
  attr_accessor :vat_registration_number
33
33
 
34
- # Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the card_acceptor_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)
34
+ # 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)
35
35
  attr_accessor :card_acceptor_reference_number
36
36
 
37
- # Local date and time at your physical location. Include both the date and time in this field or leave it blank. This field is supported only for **CyberSource through VisaNet**. For processor-specific information, see the transaction_local_date_time field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) `Format: YYYYMMDDhhmmss`, where: - YYYY = year - MM = month - DD = day - hh = hour - mm = minutes - ss = seconds For processor-specific information, see the _transaction_local_date_time_ field in Credit Card Services Using the SCMP API.
37
+ # Local date and time at your physical location. Include both the date and time in this field or leave it blank. This field is supported only for **CyberSource through VisaNet**. For processor-specific information, see the `transaction_local_date_time` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) Format: `YYYYMMDDhhmmss`, where: - YYYY = year - MM = month - DD = day - hh = hour - mm = minutes - ss = seconds For processor-specific information, see the `transaction_local_date_time` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
38
38
  attr_accessor :transaction_local_date_time
39
39
 
40
40
  attr_accessor :service_fee_descriptor
@@ -14,28 +14,28 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsMerchantInformationMerchantDescriptor
17
- # For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) For Payouts: * Paymentech (22)
17
+ # Merchant's name. For more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.
18
18
  attr_accessor :name
19
19
 
20
- # For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
20
+ # An alternate name for the merchant. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_alternate` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->
21
21
  attr_accessor :alternate_name
22
22
 
23
- # For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * FDCCompass (13) * Paymentech (13)
23
+ # For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_contact` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)--> Contact information for the merchant. **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13)
24
24
  attr_accessor :contact
25
25
 
26
- # For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
26
+ # First line of merchant's address. For the descriptions, used-by information, data types, and lengths for these fields, see `merchant_descriptor_street` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
27
27
  attr_accessor :address1
28
28
 
29
- # Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
29
+ # Merchant's City. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
30
30
  attr_accessor :locality
31
31
 
32
- # For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
32
+ # Merchant's country. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
33
33
  attr_accessor :country
34
34
 
35
- # For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
35
+ # Merchant's postal code. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_postal_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
36
36
  attr_accessor :postal_code
37
37
 
38
- # Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
38
+ # The state where the merchant is located. For the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_state` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
39
39
  attr_accessor :administrative_area
40
40
 
41
41
  # 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 Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction
17
- # Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code **All Processors**\\ See \"Merchant-Initiated Transactions,\" page 196. For CyberSource through VisaNet, see also \"Incremental Authorizations,\" page 40.
17
+ # Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
18
18
  attr_accessor :reason
19
19
 
20
20
  # Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_ in the reply message for either the original merchant-initiated payment in the series or the previous merchant-initiated payment in the series. If the current payment request includes a token instead of an account number, the following time limits apply for the value of this field: - For a **resubmission**, the transaction ID must be less than 14 days old. - For a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet.
@@ -14,10 +14,10 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsOrderInformationAmountDetails
17
- # Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in: Table 15, \"Authorization Information for Specific Processors,\" on page 43 Table 19, \"Capture Information for Specific Processors,\" on page 58 Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used.
17
+ # Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) <!--Table 15, \"Authorization Information for Specific Processors,\" on page 43.--> #### DCC for First Data Not used.
18
18
  attr_accessor :total_amount
19
19
 
20
- # Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.
20
+ # Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).
21
21
  attr_accessor :currency
22
22
 
23
23
  # Total discount amount applied to the order. For processor-specific information, see the order_discount_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
@@ -44,13 +44,13 @@ module CyberSource
44
44
  # Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
45
45
  attr_accessor :freight_amount
46
46
 
47
- # Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. For processor-specific information, see the foreign_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
47
+ # Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
48
48
  attr_accessor :foreign_amount
49
49
 
50
- # Your customer’s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. For processor-specific information, see the foreign_currency field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
50
+ # Set this field to the converted amount that was returned by the DCC provider. For processor-specific information, see the `foreign_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
51
51
  attr_accessor :foreign_currency
52
52
 
53
- # Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. For processor-specific information, see the exchange_rate field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
53
+ # Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)<!--For details, see \"Dynamic Currency Conversion for First Data,\" page 113.--> For processor-specific information, see the `exchange_rate` field description in [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
54
54
  attr_accessor :exchange_rate
55
55
 
56
56
  # Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. For processor-specific information, see the exchange_rate_timestamp field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
@@ -71,10 +71,10 @@ module CyberSource
71
71
  # Service fee. Required for service fee transactions.
72
72
  attr_accessor :service_fee_amount
73
73
 
74
- # Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places. For details, see Dynamic Currency Conversion with a Third Party Provider.
74
+ # Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places. For details, see the `original_amount` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
75
75
  attr_accessor :original_amount
76
76
 
77
- # Your local pricing currency code. For the possible values, see the ISO Standard Currency Codes. For details, see Dynamic Currency Conversion with a Third Party Provider.
77
+ # 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) For details, see `original_currency` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For details about converting a foreign cardholder’s purchase from your local pricing currency to the cardholder’s billing currency, see the [Dynamic Currency Conversion with a Third Party Provider Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).
78
78
  attr_accessor :original_currency
79
79
 
80
80
  # 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 Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts
17
- # Additional amount type. This field is supported only for **American Express Direct**. For processor-specific information, see the additional_amount_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
17
+ # Additional amount type. This field is supported only for **American Express Direct**. For processor-specific information, see the `additional_amount_type` 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 :code
19
19
 
20
20
  # Additional amount. This field is supported only for **American Express Direct**. For processor-specific information, see the additional_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
@@ -14,25 +14,25 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsOrderInformationAmountDetailsTaxDetails
17
- # This is used to determine what type of tax related data should be inclued under _taxDetails_ object. Possible values: - alternate - local - national - vat
17
+ # Indicates the type of tax data for the _taxDetails_ object. Possible values: For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax` or `vat_tax_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
18
18
  attr_accessor :type
19
19
 
20
- # Please see below table for related decription based on above _type_ field. | type | type description | |-----------|--------------------| | alternate | Total amount of alternate tax for the order. | | local | Sales tax for the order. | | national | National tax for the order. | | vat | Total amount of VAT or other tax included in the order. | | other | Other tax. |
20
+ # Indicates the amount of tax based on the `type` field as described in the table below: | type | type description | |-----------|--------------------| | `alternate` | Total amount of alternate tax for the order. | | `local` | Sales tax for the order. | | `national` | National tax for the order. | | `vat` | Total amount of Value Added Tax (VAT) included in the order. | | `other` | Other tax. | For processor-specific details, see the `alternate_tax_amount`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_amount` field descriptions in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
21
21
  attr_accessor :amount
22
22
 
23
- # Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated)
23
+ # Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) For processor-specific details, see the `alternate_tax_amount`, `vat_rate`, `vat_tax_rate`, `local_tax`, `national_tax`, `vat_tax_amount` or `other_tax#_rate` field descriptions in the [Level II and Level III Processing Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
24
24
  attr_accessor :rate
25
25
 
26
- # Type of tax being applied to the item. Possible values: Below values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle** - 0000: unknown tax type - 0001: federal/national sales tax - 0002: state sales tax - 0003: city sales tax - 0004: local sales tax - 0005: municipal sales tax - 0006: other tax - 0010: value-added tax (VAT) - 0011: goods and services tax (GST) - 0012: provincial sales tax - 0013: harmonized sales tax - 0014: Quebec sales tax (QST) - 0020: room tax - 0021: occupancy tax - 0022: energy tax - 0023: city tax - 0024: county or parish sales tax - 0025: county tax - 0026: environment tax - 0027: state and local sales tax (combined) - Blank: Tax not supported on line item.
26
+ # Type of tax being applied to the item. For possible values, see the processor-specific field descriptions in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm): #### FDC Nashville Global - `alternate_tax_type_applied` - `alternate_tax_type_identifier` #### Worldpay VAP - `alternate_tax_type_identifier` #### RBS WorldPay Atlanta - `tax_type_applied` #### TSYS Acquiring Solutions - `tax_type_applied` - `local_tax_indicator` #### Chase Paymentech Solutions - `tax_type_applied` #### Elavon Americas - `local_tax_indicator` #### FDC Compass - `tax_type_applied` #### OmniPay Direct - `local_tax_indicator`
27
27
  attr_accessor :code
28
28
 
29
- # Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount.
29
+ # Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. For processor-specific details, see `alternate_tax_id` field description in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
30
30
  attr_accessor :tax_id
31
31
 
32
- # The tax is applied. Valid value is `true` or `false`.
32
+ # Flag that indicates whether the alternate tax amount (`orderInformation.amountDetails.taxDetails[].amount`) is included in the request. Possible values: - `false`: alternate tax amount is not included in the request. - `true`: alternate tax amount is included in the request. For processor-specific details, see `alternate_tax_amount_indicator` field description in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
33
33
  attr_accessor :applied
34
34
 
35
- # Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. For possible values, see Exemption Status Values. See Numbered Elements. Important For information about using this field, see Item-Level Tax Fields.
35
+ # Status code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. For possible values and important information for using this field, see _Appendix B, \"Exemption Status Values_ and _Offer-Level Tax Fields_ in [Level II and Level III Processing Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)
36
36
  attr_accessor :exemption_code
37
37
 
38
38
  class EnumAttributeValidator
@@ -150,7 +150,7 @@ module CyberSource
150
150
  # Check to see if the all the properties in the model are valid
151
151
  # @return true if the model is valid
152
152
  def valid?
153
- type_validator = EnumAttributeValidator.new('String', ['alternate', 'local', 'national', 'vat'])
153
+ type_validator = EnumAttributeValidator.new('String', ['alternate', 'local', 'national', 'vat', 'other'])
154
154
  return false unless type_validator.valid?(@type)
155
155
  return false if !@amount.nil? && @amount.to_s.length > 13
156
156
  return false if !@rate.nil? && @rate.to_s.length > 6
@@ -163,7 +163,7 @@ module CyberSource
163
163
  # Custom attribute writer method checking allowed values (enum).
164
164
  # @param [Object] type Object to be assigned
165
165
  def type=(type)
166
- validator = EnumAttributeValidator.new('String', ['alternate', 'local', 'national', 'vat'])
166
+ validator = EnumAttributeValidator.new('String', ['alternate', 'local', 'national', 'vat', 'other'])
167
167
  unless validator.valid?(type)
168
168
  fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.'
169
169
  end