cybersource_rest_client 0.0.22 → 0.0.24

Sign up to get free protection for your applications and to get access to all the features.
Files changed (502) hide show
  1. checksums.yaml +4 -4
  2. data/lib/cybersource_rest_client.rb +197 -108
  3. data/lib/cybersource_rest_client/api/asymmetric_key_management_api.rb +219 -0
  4. data/lib/cybersource_rest_client/api/customer_api.rb +360 -0
  5. data/lib/cybersource_rest_client/api/customer_payment_instrument_api.rb +516 -0
  6. data/lib/cybersource_rest_client/api/customer_shipping_address_api.rb +516 -0
  7. data/lib/cybersource_rest_client/api/decision_manager_api.rb +15 -15
  8. data/lib/cybersource_rest_client/api/download_dtd_api.rb +1 -1
  9. data/lib/cybersource_rest_client/api/download_xsd_api.rb +1 -1
  10. data/lib/cybersource_rest_client/api/instrument_identifier_api.rb +165 -174
  11. data/lib/cybersource_rest_client/api/key_generation_api.rb +10 -6
  12. data/lib/cybersource_rest_client/api/notification_of_changes_api.rb +1 -1
  13. data/lib/cybersource_rest_client/api/payer_authentication_api.rb +65 -0
  14. data/lib/cybersource_rest_client/api/payment_batch_summaries_api.rb +1 -1
  15. data/lib/cybersource_rest_client/api/payment_instrument_api.rb +131 -136
  16. data/lib/cybersource_rest_client/api/payments_api.rb +2 -2
  17. data/lib/cybersource_rest_client/api/purchase_and_refund_details_api.rb +1 -1
  18. data/lib/cybersource_rest_client/api/refund_api.rb +4 -4
  19. data/lib/cybersource_rest_client/api/report_subscriptions_api.rb +45 -0
  20. data/lib/cybersource_rest_client/api/reversal_api.rb +4 -4
  21. data/lib/cybersource_rest_client/api/symmetric_key_management_api.rb +219 -0
  22. data/lib/cybersource_rest_client/api/taxes_api.rb +160 -0
  23. data/lib/cybersource_rest_client/api/user_management_api.rb +4 -4
  24. data/lib/cybersource_rest_client/api/user_management_search_api.rb +89 -0
  25. data/lib/cybersource_rest_client/api/void_api.rb +8 -8
  26. data/lib/cybersource_rest_client/api_client.rb +37 -24
  27. data/lib/cybersource_rest_client/models/capture_payment_request.rb +1 -1
  28. data/lib/cybersource_rest_client/models/check_payer_auth_enrollment_request.rb +14 -5
  29. data/lib/cybersource_rest_client/models/{create_decision_manager_case_request.rb → create_bundled_decision_manager_case_request.rb} +50 -14
  30. data/lib/cybersource_rest_client/models/create_credit_request.rb +1 -1
  31. data/lib/cybersource_rest_client/models/create_p12_keys_request.rb +194 -0
  32. data/lib/cybersource_rest_client/models/create_payment_request.rb +10 -1
  33. data/lib/cybersource_rest_client/models/create_search_request.rb +7 -7
  34. data/lib/cybersource_rest_client/models/create_shared_secret_keys_request.rb +194 -0
  35. data/lib/cybersource_rest_client/models/customer.rb +292 -0
  36. data/lib/cybersource_rest_client/models/delete_bulk_p12_keys_request.rb +194 -0
  37. data/lib/cybersource_rest_client/models/delete_bulk_symmetric_keys_request.rb +194 -0
  38. data/lib/cybersource_rest_client/models/inline_response_200.rb +203 -0
  39. data/lib/cybersource_rest_client/models/inline_response_200_1.rb +214 -0
  40. data/lib/cybersource_rest_client/models/inline_response_200_1_key_information.rb +224 -0
  41. data/lib/cybersource_rest_client/models/inline_response_200_2.rb +193 -0
  42. data/lib/cybersource_rest_client/models/{flex_v1_tokens_post200_response.rb → inline_response_200_2_key_information.rb} +55 -56
  43. data/lib/cybersource_rest_client/models/inline_response_200_3.rb +204 -0
  44. data/lib/cybersource_rest_client/models/inline_response_200_3_key_information.rb +234 -0
  45. data/lib/cybersource_rest_client/models/{tmsv1instrumentidentifiers_bill_to.rb → inline_response_200_key_information.rb} +44 -44
  46. data/lib/cybersource_rest_client/models/inline_response_201.rb +214 -0
  47. data/lib/cybersource_rest_client/models/inline_response_201_1.rb +225 -0
  48. data/lib/cybersource_rest_client/models/inline_response_201_1_certificate_information.rb +214 -0
  49. data/lib/cybersource_rest_client/models/inline_response_201_1_key_information.rb +264 -0
  50. data/lib/cybersource_rest_client/models/inline_response_201_error_information.rb +195 -0
  51. data/lib/cybersource_rest_client/models/{instrument_identifier_bank_account.rb → inline_response_201_key_information.rb} +73 -61
  52. data/lib/cybersource_rest_client/models/inline_response_400.rb +9 -26
  53. data/lib/cybersource_rest_client/models/inline_response_400_2.rb +214 -0
  54. data/lib/cybersource_rest_client/models/{tmsv1instrumentidentifiers_details.rb → inline_response_400_details.rb} +3 -3
  55. data/lib/cybersource_rest_client/models/{payment_instrument_bank_account.rb → inline_response_400_errors.rb} +27 -6
  56. data/lib/cybersource_rest_client/models/{instrument_identifier_response.rb → instrument_identifier.rb} +39 -20
  57. data/lib/cybersource_rest_client/models/invoicing_v2_invoice_settings_get200_response.rb +1 -1
  58. data/lib/cybersource_rest_client/models/invoicing_v2_invoice_settings_get200_response_invoice_settings_information.rb +54 -4
  59. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response.rb +1 -1
  60. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb +1 -1
  61. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_order_information_amount_details.rb +2 -2
  62. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get400_response.rb +1 -1
  63. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get404_response.rb +1 -1
  64. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get502_response.rb +2 -2
  65. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_get200_response.rb +2 -2
  66. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_get200_response_invoice_history.rb +2 -2
  67. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_get200_response_transaction_details.rb +1 -1
  68. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_post201_response.rb +2 -2
  69. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_post201_response_order_information_amount_details.rb +4 -4
  70. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_post202_response.rb +1 -1
  71. data/lib/cybersource_rest_client/models/invoicingv2invoices_customer_information.rb +1 -1
  72. data/lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb +3 -3
  73. data/lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb +1 -1
  74. data/lib/cybersource_rest_client/models/invoicingv2invoices_order_information_line_items.rb +4 -4
  75. data/lib/cybersource_rest_client/models/kmsv2keysasym_key_information.rb +215 -0
  76. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_post200_response_card.rb → kmsv2keyssym_client_reference_information.rb} +36 -26
  77. data/lib/cybersource_rest_client/models/kmsv2keyssym_key_information.rb +200 -0
  78. data/lib/cybersource_rest_client/models/kmsv2keyssymdeletes_key_information.rb +215 -0
  79. data/lib/cybersource_rest_client/models/patch_customer_payment_instrument_request.rb +318 -0
  80. data/lib/cybersource_rest_client/models/patch_customer_request.rb +292 -0
  81. data/lib/cybersource_rest_client/models/patch_customer_shipping_address_request.rb +235 -0
  82. data/lib/cybersource_rest_client/models/{embedded_instrument_identifier_response.rb → patch_instrument_identifier_request.rb} +45 -50
  83. data/lib/cybersource_rest_client/models/{payment_instrument_instrument_identifier_request.rb → patch_payment_instrument_request.rb} +92 -20
  84. data/lib/cybersource_rest_client/models/{update_instrument_identifier_request.rb → payer_auth_setup_request.rb} +32 -5
  85. data/lib/cybersource_rest_client/models/payment_instrument.rb +51 -18
  86. data/lib/cybersource_rest_client/models/{payment_instruments_for_instrument_identifier.rb → payment_instrument_list_for_customer.rb} +9 -19
  87. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response__embedded.rb → payment_instrument_list_for_customer__embedded.rb} +3 -3
  88. data/lib/cybersource_rest_client/models/{payment_instrument_for_instrument_identifier_links.rb → payment_instrument_list_for_customer__links.rb} +6 -6
  89. data/lib/cybersource_rest_client/models/payment_instrument_list_for_customer__links_first.rb +184 -0
  90. data/lib/cybersource_rest_client/models/{payment_instrument_self_link.rb → payment_instrument_list_for_customer__links_last.rb} +2 -1
  91. data/lib/cybersource_rest_client/models/payment_instrument_list_for_customer__links_next.rb +184 -0
  92. data/lib/cybersource_rest_client/models/payment_instrument_list_for_customer__links_prev.rb +184 -0
  93. data/lib/cybersource_rest_client/models/payment_instrument_list_for_customer__links_self.rb +184 -0
  94. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response.rb → payment_instrument_paginated.rb} +9 -19
  95. data/lib/cybersource_rest_client/models/post_customer_payment_instrument_request.rb +318 -0
  96. data/lib/cybersource_rest_client/models/post_customer_request.rb +292 -0
  97. data/lib/cybersource_rest_client/models/post_customer_shipping_address_request.rb +235 -0
  98. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_post200_response.rb → post_instrument_identifier_request.rb} +39 -20
  99. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response_payment_instruments.rb → post_payment_instrument_request.rb} +52 -19
  100. data/lib/cybersource_rest_client/models/pts_v1_transaction_batches_get200_response.rb +1 -1
  101. data/lib/cybersource_rest_client/models/pts_v1_transaction_batches_get400_response.rb +1 -1
  102. data/lib/cybersource_rest_client/models/pts_v1_transaction_batches_get500_response.rb +1 -1
  103. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response.rb +3 -3
  104. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response_credit_amount_details.rb +2 -2
  105. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response_payment_information.rb +40 -4
  106. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response_processing_information.rb +1 -1
  107. data/lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response.rb +3 -3
  108. data/lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_client_reference_information.rb +1 -1
  109. data/lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_payment_information_account_features.rb +1 -1
  110. data/lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb +4 -4
  111. data/lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch400_response.rb +1 -1
  112. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post201_response.rb +16 -16
  113. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post201_response_order_information_amount_details.rb +1 -1
  114. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post201_response_order_information_invoice_details.rb +1 -1
  115. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post201_response_point_of_sale_information.rb +1 -1
  116. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post201_response_processing_information.rb +1 -1
  117. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post400_response.rb +1 -1
  118. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response.rb +14 -5
  119. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response__links.rb +40 -4
  120. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_client_reference_information.rb +3 -3
  121. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_consumer_authentication_information.rb +1 -1
  122. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_error_information.rb +1 -1
  123. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_issuer_information.rb +2 -2
  124. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_amount_details.rb +2 -2
  125. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_invoice_details.rb +2 -2
  126. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb +40 -4
  127. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb +16 -16
  128. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_card.rb +1 -1
  129. data/lib/cybersource_rest_client/models/{embedded_instrument_identifier_request.rb → pts_v2_payments_post201_response_payment_information_instrument_identifier.rb} +15 -23
  130. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb +3 -3
  131. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb +1 -1
  132. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information_emv.rb +1 -1
  133. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processing_information.rb +1 -1
  134. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information.rb +8 -8
  135. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_avs.rb +2 -2
  136. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_consumer_authentication_response.rb +2 -2
  137. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_customer.rb +1 -1
  138. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_merchant_advice.rb +5 -5
  139. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_routing.rb +3 -3
  140. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_info_codes.rb +8 -8
  141. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_velocity.rb +1 -1
  142. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_velocity_morphing.rb +1 -1
  143. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_token_information.rb +220 -0
  144. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_token_information_customer.rb +208 -0
  145. data/lib/cybersource_rest_client/models/{tmsv1paymentinstruments_instrument_identifier.rb → pts_v2_payments_post201_response_token_information_instrument_identifier.rb} +15 -23
  146. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_token_information_payment_instrument.rb +208 -0
  147. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_token_information_shipping_address.rb +208 -0
  148. data/lib/cybersource_rest_client/models/pts_v2_payments_post400_response.rb +1 -1
  149. data/lib/cybersource_rest_client/models/pts_v2_payments_post502_response.rb +2 -2
  150. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response.rb +3 -3
  151. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb +2 -2
  152. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_refund_amount_details.rb +1 -1
  153. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post400_response.rb +1 -1
  154. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response.rb +3 -3
  155. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_issuer_information.rb +1 -1
  156. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb +2 -2
  157. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_reversal_amount_details.rb +3 -3
  158. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post400_response.rb +1 -1
  159. data/lib/cybersource_rest_client/models/pts_v2_payments_voids_post201_response.rb +2 -2
  160. data/lib/cybersource_rest_client/models/pts_v2_payments_voids_post201_response_processor_information.rb +1 -1
  161. data/lib/cybersource_rest_client/models/pts_v2_payments_voids_post201_response_void_amount_details.rb +2 -2
  162. data/lib/cybersource_rest_client/models/pts_v2_payments_voids_post400_response.rb +1 -1
  163. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response.rb +1 -1
  164. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_merchant_information_merchant_descriptor.rb +3 -3
  165. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_order_information_amount_details.rb +2 -2
  166. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_processor_information.rb +1 -1
  167. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb +4 -4
  168. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information_electronic_benefits_transfer.rb +1 -1
  169. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information_purchase_options.rb +1 -1
  170. data/lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb +1 -1
  171. data/lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb +1 -1
  172. data/lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb +1 -1
  173. data/lib/cybersource_rest_client/models/ptsv2payments_client_reference_information.rb +2 -2
  174. data/lib/cybersource_rest_client/models/ptsv2payments_client_reference_information_partner.rb +3 -3
  175. data/lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb +27 -2
  176. data/lib/cybersource_rest_client/models/ptsv2payments_device_information.rb +1 -1
  177. data/lib/cybersource_rest_client/models/{instrument_identifier_update.rb → ptsv2payments_health_care_information.rb} +11 -8
  178. data/lib/cybersource_rest_client/models/{tmsv1instrumentidentifiers_bank_account.rb → ptsv2payments_health_care_information_amount_details.rb} +32 -50
  179. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb +2 -2
  180. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb +5 -5
  181. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb +16 -16
  182. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_amex_additional_amounts.rb +1 -1
  183. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_surcharge.rb +1 -1
  184. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb +1 -1
  185. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb +10 -10
  186. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to_company.rb +1 -1
  187. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb +31 -6
  188. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb +6 -6
  189. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_passenger.rb +2 -2
  190. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb +8 -8
  191. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb +47 -2
  192. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb +8 -8
  193. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_customer.rb +38 -4
  194. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb +2 -2
  195. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_instrument_identifier.rb +208 -0
  196. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_legacy_token.rb +199 -0
  197. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_payment_instrument.rb +208 -0
  198. data/lib/cybersource_rest_client/models/{ptsv2paymentsidrefunds_payment_information_payment_type.rb → ptsv2payments_payment_information_payment_type.rb} +4 -4
  199. data/lib/cybersource_rest_client/models/{ptsv2paymentsidrefunds_payment_information_payment_type_method.rb → ptsv2payments_payment_information_payment_type_method.rb} +1 -1
  200. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_shipping_address.rb +208 -0
  201. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb +4 -4
  202. data/lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb +18 -18
  203. data/lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information_emv.rb +5 -5
  204. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information.rb +31 -7
  205. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb +55 -15
  206. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_capture_options.rb +1 -1
  207. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_electronic_benefits_transfer.rb +2 -2
  208. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_japan_payment_options.rb +2 -2
  209. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_purchase_options.rb +2 -2
  210. data/lib/cybersource_rest_client/models/ptsv2payments_token_information.rb +22 -4
  211. data/lib/cybersource_rest_client/models/ptsv2payments_token_information_payment_instrument.rb +186 -0
  212. data/lib/cybersource_rest_client/models/{authorization_options.rb → ptsv2payments_token_information_shipping_address.rb} +11 -8
  213. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information.rb +11 -2
  214. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_agency.rb +1 -1
  215. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental.rb +1146 -0
  216. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_rental_address.rb +349 -0
  217. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_return_address.rb +299 -0
  218. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_auto_rental_tax_details.rb +309 -0
  219. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_lodging.rb +2 -2
  220. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_lodging_room.rb +1 -1
  221. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_transit_airline.rb +25 -25
  222. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_transit_airline_ancillary_information.rb +4 -4
  223. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_transit_airline_ancillary_information_service.rb +2 -2
  224. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_transit_airline_legs.rb +19 -19
  225. data/lib/cybersource_rest_client/models/ptsv2payments_travel_information_transit_airline_ticket_issuer.rb +2 -2
  226. data/lib/cybersource_rest_client/models/ptsv2paymentsid_client_reference_information.rb +1 -1
  227. data/lib/cybersource_rest_client/models/ptsv2paymentsid_client_reference_information_partner.rb +2 -2
  228. data/lib/cybersource_rest_client/models/ptsv2paymentsid_merchant_information.rb +1 -1
  229. data/lib/cybersource_rest_client/models/ptsv2paymentsid_order_information_amount_details.rb +1 -1
  230. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_aggregator_information_sub_merchant.rb +1 -1
  231. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_buyer_information.rb +1 -1
  232. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_device_information.rb +1 -1
  233. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb +1 -1
  234. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb +15 -15
  235. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_bill_to.rb +10 -10
  236. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_ship_to.rb +3 -3
  237. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_payment_information_card.rb +1 -1
  238. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_point_of_sale_information_emv.rb +2 -2
  239. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information.rb +2 -2
  240. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb +3 -3
  241. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_merchant_information.rb +1 -1
  242. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_order_information_line_items.rb +6 -6
  243. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information.rb +38 -2
  244. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_card.rb +5 -5
  245. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb +2 -2
  246. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb +1 -1
  247. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information_partner.rb +2 -2
  248. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_order_information_line_items.rb +2 -2
  249. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_point_of_sale_information_emv.rb +1 -1
  250. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_processing_information.rb +1 -1
  251. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_reversal_information.rb +1 -1
  252. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_reversal_information_amount_details.rb +2 -2
  253. data/lib/cybersource_rest_client/models/ptsv2paymentsidvoids_payment_information.rb +1 -1
  254. data/lib/cybersource_rest_client/models/ptsv2payouts_client_reference_information.rb +1 -1
  255. data/lib/cybersource_rest_client/models/ptsv2payouts_merchant_information.rb +1 -1
  256. data/lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb +5 -5
  257. data/lib/cybersource_rest_client/models/ptsv2payouts_order_information_amount_details.rb +2 -2
  258. data/lib/cybersource_rest_client/models/ptsv2payouts_order_information_amount_details_surcharge.rb +1 -1
  259. data/lib/cybersource_rest_client/models/ptsv2payouts_order_information_bill_to.rb +9 -9
  260. data/lib/cybersource_rest_client/models/ptsv2payouts_payment_information_card.rb +4 -4
  261. data/lib/cybersource_rest_client/models/ptsv2payouts_sender_information.rb +2 -2
  262. data/lib/cybersource_rest_client/models/refund_capture_request.rb +1 -1
  263. data/lib/cybersource_rest_client/models/refund_payment_request.rb +1 -1
  264. data/lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response.rb +4 -14
  265. data/lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb +1 -1
  266. data/lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_error_information.rb +205 -0
  267. data/lib/cybersource_rest_client/models/risk_v1_authentication_results_post201_response.rb +5 -15
  268. data/lib/cybersource_rest_client/models/risk_v1_authentication_results_post201_response_consumer_authentication_information.rb +1 -1
  269. data/lib/cybersource_rest_client/models/risk_v1_authentication_setups_post201_response.rb +246 -0
  270. data/lib/cybersource_rest_client/models/risk_v1_authentication_setups_post201_response_consumer_authentication_information.rb +249 -0
  271. data/lib/cybersource_rest_client/models/risk_v1_authentication_setups_post201_response_error_information.rb +205 -0
  272. data/lib/cybersource_rest_client/models/risk_v1_authentications_post201_response.rb +7 -17
  273. data/lib/cybersource_rest_client/models/risk_v1_authentications_post201_response_error_information.rb +205 -0
  274. data/lib/cybersource_rest_client/models/risk_v1_authentications_post400_response.rb +4 -4
  275. data/lib/cybersource_rest_client/models/risk_v1_authentications_post400_response_1.rb +225 -0
  276. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response.rb +32 -5
  277. data/lib/cybersource_rest_client/models/{risk_v1_authentications_post201_response_consumer_authentication_information.rb → risk_v1_decisions_post201_response_consumer_authentication_information.rb} +28 -3
  278. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_error_information.rb +205 -0
  279. data/lib/cybersource_rest_client/models/{risk_v1_authentications_post201_response_order_information.rb → risk_v1_decisions_post201_response_order_information.rb} +2 -2
  280. data/lib/cybersource_rest_client/models/{risk_v1_authentications_post201_response_order_information_amount_details.rb → risk_v1_decisions_post201_response_order_information_amount_details.rb} +2 -2
  281. data/lib/cybersource_rest_client/models/risk_v1_decisions_post400_response.rb +3 -3
  282. data/lib/cybersource_rest_client/models/risk_v1_decisions_post400_response_1.rb +225 -0
  283. data/lib/cybersource_rest_client/models/risk_v1_export_compliance_inquiries_post201_response.rb +4 -14
  284. data/lib/cybersource_rest_client/models/risk_v1_export_compliance_inquiries_post201_response_error_information.rb +205 -0
  285. data/lib/cybersource_rest_client/models/risk_v1_update_post201_response.rb +2 -2
  286. data/lib/cybersource_rest_client/models/riskv1addressverifications_client_reference_information.rb +2 -2
  287. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb +6 -6
  288. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb +5 -5
  289. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_ship_to.rb +7 -7
  290. data/lib/cybersource_rest_client/models/riskv1authenticationresults_consumer_authentication_information.rb +26 -1
  291. data/lib/cybersource_rest_client/models/riskv1authenticationresults_order_information_line_items.rb +3 -3
  292. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information.rb +13 -4
  293. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information_card.rb +4 -4
  294. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information_tokenized_card.rb +1 -1
  295. data/lib/cybersource_rest_client/models/riskv1authentications_device_information.rb +1 -1
  296. data/lib/cybersource_rest_client/models/riskv1authentications_order_information.rb +1 -1
  297. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_amount_details.rb +2 -2
  298. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_bill_to.rb +10 -10
  299. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb +5 -5
  300. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information.rb +13 -4
  301. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_card.rb +4 -4
  302. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_tokenized_card.rb +1 -1
  303. data/lib/cybersource_rest_client/models/riskv1authentications_travel_information.rb +2 -2
  304. data/lib/cybersource_rest_client/models/{riskv1authentications_client_reference_information.rb → riskv1authenticationsetups_client_reference_information.rb} +2 -2
  305. data/lib/cybersource_rest_client/models/{instrument_identifier_enrollable_card.rb → riskv1authenticationsetups_payment_information.rb} +24 -25
  306. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_card.rb +286 -0
  307. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_customer.rb +199 -0
  308. data/lib/cybersource_rest_client/models/{riskv1authentications_payment_information_fluid_data.rb → riskv1authenticationsetups_payment_information_fluid_data.rb} +3 -3
  309. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_tokenized_card.rb +325 -0
  310. data/lib/cybersource_rest_client/models/{riskv1authentications_processing_information.rb → riskv1authenticationsetups_processing_information.rb} +2 -2
  311. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_token_information.rb +184 -0
  312. data/lib/cybersource_rest_client/models/riskv1decisions_client_reference_information.rb +2 -2
  313. data/lib/cybersource_rest_client/models/{riskv1authentications_consumer_authentication_information.rb → riskv1decisions_consumer_authentication_information.rb} +29 -4
  314. data/lib/cybersource_rest_client/models/{riskv1authentications_consumer_authentication_information_strong_authentication.rb → riskv1decisions_consumer_authentication_information_strong_authentication.rb} +1 -1
  315. data/lib/cybersource_rest_client/models/riskv1decisions_device_information.rb +236 -5
  316. data/lib/cybersource_rest_client/models/{riskv1authentications_merchant_information.rb → riskv1decisions_merchant_information.rb} +2 -2
  317. data/lib/cybersource_rest_client/models/{riskv1authentications_merchant_information_merchant_descriptor.rb → riskv1decisions_merchant_information_merchant_descriptor.rb} +2 -2
  318. data/lib/cybersource_rest_client/models/riskv1decisions_order_information.rb +74 -4
  319. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_amount_details.rb +2 -2
  320. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_bill_to.rb +10 -10
  321. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb +104 -9
  322. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_ship_to.rb +72 -13
  323. data/lib/cybersource_rest_client/models/riskv1decisions_payment_information.rb +47 -4
  324. data/lib/cybersource_rest_client/models/riskv1decisions_payment_information_card.rb +4 -4
  325. data/lib/cybersource_rest_client/models/riskv1decisions_payment_information_tokenized_card.rb +1 -1
  326. data/lib/cybersource_rest_client/models/riskv1decisions_processing_information.rb +187 -0
  327. data/lib/cybersource_rest_client/models/riskv1decisions_processor_information.rb +13 -4
  328. data/lib/cybersource_rest_client/models/{riskv1decisions_card_verification.rb → riskv1decisions_processor_information_card_verification.rb} +1 -1
  329. data/lib/cybersource_rest_client/models/riskv1decisions_risk_information.rb +13 -4
  330. data/lib/cybersource_rest_client/models/riskv1decisions_travel_information.rb +25 -4
  331. data/lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb +26 -16
  332. data/lib/cybersource_rest_client/models/{riskv1authentications_travel_information_passengers.rb → riskv1decisions_travel_information_passengers.rb} +1 -1
  333. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_device_information.rb +1 -1
  334. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_order_information_bill_to.rb +9 -9
  335. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_order_information_line_items.rb +5 -5
  336. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_order_information_ship_to.rb +3 -3
  337. data/lib/cybersource_rest_client/models/riskv1liststypeentries_device_information.rb +1 -1
  338. data/lib/cybersource_rest_client/models/riskv1liststypeentries_order_information_bill_to.rb +10 -10
  339. data/lib/cybersource_rest_client/models/riskv1liststypeentries_order_information_line_items.rb +1 -1
  340. data/lib/cybersource_rest_client/models/riskv1liststypeentries_order_information_ship_to.rb +6 -6
  341. data/lib/cybersource_rest_client/models/riskv1liststypeentries_payment_information_card.rb +2 -2
  342. data/lib/cybersource_rest_client/models/search_request.rb +214 -0
  343. data/lib/cybersource_rest_client/models/shipping_address.rb +235 -0
  344. data/lib/cybersource_rest_client/models/shipping_address_list_for_customer.rb +233 -0
  345. data/lib/cybersource_rest_client/models/shipping_address_list_for_customer__embedded.rb +186 -0
  346. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response__links.rb → shipping_address_list_for_customer__links.rb} +6 -6
  347. data/lib/cybersource_rest_client/models/shipping_address_list_for_customer__links_first.rb +184 -0
  348. data/lib/cybersource_rest_client/models/{pi_for_ii_link_self.rb → shipping_address_list_for_customer__links_last.rb} +2 -2
  349. data/lib/cybersource_rest_client/models/{instrument_identifier_payment_instruments_link.rb → shipping_address_list_for_customer__links_next.rb} +2 -1
  350. data/lib/cybersource_rest_client/models/shipping_address_list_for_customer__links_prev.rb +184 -0
  351. data/lib/cybersource_rest_client/models/shipping_address_list_for_customer__links_self.rb +184 -0
  352. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_delete409_response.rb → shipping_address_paginated.rb} +55 -5
  353. data/lib/cybersource_rest_client/models/tax_request.rb +219 -0
  354. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response__embedded_bank_account.rb → tms_error.rb} +27 -6
  355. data/lib/cybersource_rest_client/models/{detail.rb → tms_error_details.rb} +3 -3
  356. data/lib/cybersource_rest_client/models/tms_error_response.rb +185 -0
  357. data/lib/cybersource_rest_client/models/tms_v2_customers_response.rb +292 -0
  358. data/lib/cybersource_rest_client/models/{tokenize_request.rb → tmsv2customers__embedded.rb} +15 -20
  359. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_post200_response_processing_information_authorization_options.rb → tmsv2customers__embedded_authorization_options.rb} +2 -2
  360. data/lib/cybersource_rest_client/models/{initiator.rb → tmsv2customers__embedded_authorization_options_initiator.rb} +2 -2
  361. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument.rb +318 -0
  362. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response__embedded__embedded.rb → tmsv2customers__embedded_default_payment_instrument__embedded.rb} +3 -2
  363. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_embedded_instrument_identifier.rb → tmsv2customers__embedded_default_payment_instrument__embedded_instrument_identifier.rb} +45 -50
  364. data/lib/cybersource_rest_client/models/{model_409_links.rb → tmsv2customers__embedded_default_payment_instrument__embedded_instrument_identifier__links.rb} +12 -3
  365. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument__embedded_instrument_identifier__links_self.rb +184 -0
  366. data/lib/cybersource_rest_client/models/{instrument_identifier_card.rb → tmsv2customers__embedded_default_payment_instrument__embedded_instrument_identifier_bank_account.rb} +21 -20
  367. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument__embedded_instrument_identifier_bill_to.rb +325 -0
  368. data/lib/cybersource_rest_client/models/{tmsv1instrumentidentifiers_card.rb → tmsv2customers__embedded_default_payment_instrument__embedded_instrument_identifier_card.rb} +6 -32
  369. data/lib/cybersource_rest_client/models/{issuer.rb → tmsv2customers__embedded_default_payment_instrument__embedded_instrument_identifier_issuer.rb} +7 -16
  370. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument__embedded_instrument_identifier_metadata.rb +184 -0
  371. data/lib/cybersource_rest_client/models/{payment_instruments_links.rb → tmsv2customers__embedded_default_payment_instrument__links.rb} +14 -5
  372. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument__links_self.rb +184 -0
  373. data/lib/cybersource_rest_client/models/{create_instrument_identifier_request.rb → tmsv2customers__embedded_default_payment_instrument_bank_account.rb} +21 -33
  374. data/lib/cybersource_rest_client/models/{bill_to.rb → tmsv2customers__embedded_default_payment_instrument_bill_to.rb} +27 -45
  375. data/lib/cybersource_rest_client/models/{buyer_information.rb → tmsv2customers__embedded_default_payment_instrument_buyer_information.rb} +6 -39
  376. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response_buyer_information_issued_by.rb → tmsv2customers__embedded_default_payment_instrument_buyer_information_issued_by.rb} +17 -2
  377. data/lib/cybersource_rest_client/models/{personal_identification.rb → tmsv2customers__embedded_default_payment_instrument_buyer_information_personal_identification.rb} +19 -4
  378. data/lib/cybersource_rest_client/models/{payment_instrument_card.rb → tmsv2customers__embedded_default_payment_instrument_card.rb} +21 -62
  379. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_card_tokenized_information.rb +224 -0
  380. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response_personal_identification.rb → tmsv2customers__embedded_default_payment_instrument_instrument_identifier.rb} +30 -25
  381. data/lib/cybersource_rest_client/models/{merchant_information.rb → tmsv2customers__embedded_default_payment_instrument_merchant_information.rb} +2 -2
  382. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response_merchant_descriptor.rb → tmsv2customers__embedded_default_payment_instrument_merchant_information_merchant_descriptor.rb} +17 -2
  383. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_metadata.rb +184 -0
  384. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response_processing_information.rb → tmsv2customers__embedded_default_payment_instrument_processing_information.rb} +3 -5
  385. data/lib/cybersource_rest_client/models/{merchant_initiated_transaction.rb → tmsv2customers__embedded_default_payment_instrument_processing_information_bank_transfer_options.rb} +17 -17
  386. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_shipping_address.rb +235 -0
  387. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response__embedded__links.rb → tmsv2customers__embedded_default_shipping_address__links.rb} +14 -5
  388. data/lib/cybersource_rest_client/models/{pi_for_ii_link_last.rb → tmsv2customers__embedded_default_shipping_address__links_customer.rb} +2 -2
  389. data/lib/cybersource_rest_client/models/{pi_for_ii_link_first.rb → tmsv2customers__embedded_default_shipping_address__links_self.rb} +2 -2
  390. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_post200_response_metadata.rb → tmsv2customers__embedded_default_shipping_address_metadata.rb} +2 -2
  391. data/lib/cybersource_rest_client/models/{riskv1authentications_order_information_ship_to.rb → tmsv2customers__embedded_default_shipping_address_ship_to.rb} +140 -150
  392. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_post200_response_merchant_initiated_transaction.rb → tmsv2customers__embedded_merchant_initiated_transaction.rb} +2 -2
  393. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_payment_instruments.rb +184 -0
  394. data/lib/cybersource_rest_client/models/{instrument_identifier_processing_information.rb → tmsv2customers__embedded_processing_information.rb} +2 -2
  395. data/lib/cybersource_rest_client/models/{instrument_identifier_tokenized_card.rb → tmsv2customers__embedded_tokenized_card.rb} +33 -32
  396. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_post200_response_tokenized_card_card.rb → tmsv2customers__embedded_tokenized_card_card.rb} +5 -23
  397. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_post200_response__links.rb → tmsv2customers__links.rb} +10 -19
  398. data/lib/cybersource_rest_client/models/tmsv2customers__links_payment_instruments.rb +184 -0
  399. data/lib/cybersource_rest_client/models/{model_409_link.rb → tmsv2customers__links_self.rb} +2 -1
  400. data/lib/cybersource_rest_client/models/tmsv2customers__links_shipping_address.rb +184 -0
  401. data/lib/cybersource_rest_client/models/tmsv2customers_buyer_information.rb +224 -0
  402. data/lib/cybersource_rest_client/models/{ptsv2paymentsidcaptures_travel_information.rb → tmsv2customers_client_reference_information.rb} +24 -26
  403. data/lib/cybersource_rest_client/models/tmsv2customers_default_payment_instrument.rb +184 -0
  404. data/lib/cybersource_rest_client/models/tmsv2customers_default_shipping_address.rb +184 -0
  405. data/lib/cybersource_rest_client/models/tmsv2customers_merchant_defined_information.rb +209 -0
  406. data/lib/cybersource_rest_client/models/{metadata.rb → tmsv2customers_metadata.rb} +2 -2
  407. data/lib/cybersource_rest_client/models/tmsv2customers_object_information.rb +224 -0
  408. data/lib/cybersource_rest_client/models/tokenize_parameters.rb +1 -1
  409. data/lib/cybersource_rest_client/models/{flexv1tokens_card_info.rb → tokenize_parameters_card_info.rb} +1 -1
  410. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response.rb +4 -4
  411. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_application_information.rb +2 -2
  412. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_application_information_applications.rb +1 -1
  413. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb +2 -2
  414. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_device_information.rb +1 -1
  415. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_fraud_marking_information.rb +1 -1
  416. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_merchant_information_merchant_descriptor.rb +1 -1
  417. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_amount_details.rb +4 -4
  418. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb +10 -10
  419. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_invoice_details.rb +1 -1
  420. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb +1 -1
  421. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb +8 -8
  422. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information.rb +1 -1
  423. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_account_features.rb +3 -3
  424. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb +4 -4
  425. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_payment_type.rb +1 -1
  426. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_point_of_sale_information.rb +28 -3
  427. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb +1 -1
  428. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information_authorization_options.rb +1 -1
  429. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information_bank_transfer_options.rb +1 -1
  430. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information_japan_payment_options.rb +1 -1
  431. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb +5 -5
  432. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response.rb +8 -8
  433. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_application_information.rb +5 -15
  434. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_application_information_applications.rb +244 -0
  435. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_client_reference_information.rb +1 -1
  436. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_device_information.rb +1 -1
  437. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_merchant_information.rb +1 -1
  438. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_order_information_bill_to.rb +5 -5
  439. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_order_information_ship_to.rb +4 -4
  440. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_payment_information.rb +1 -1
  441. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_payment_information_card.rb +2 -2
  442. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_point_of_sale_information.rb +3 -3
  443. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_processing_information.rb +1 -1
  444. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_processor_information.rb +1 -1
  445. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_transaction_summaries.rb +2 -2
  446. data/lib/cybersource_rest_client/models/tss_v2_transactions_post400_response.rb +1 -1
  447. data/lib/cybersource_rest_client/models/validate_request.rb +2 -2
  448. data/lib/cybersource_rest_client/models/vas_v2_payments_post201_response.rb +255 -0
  449. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_post200_response__links_payment_instruments.rb → vas_v2_payments_post201_response__links.rb} +8 -8
  450. data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_post200_response_tokenized_card.rb → vas_v2_payments_post201_response_order_information.rb} +75 -67
  451. data/lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_jurisdiction.rb +384 -0
  452. data/lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_line_items.rb +271 -0
  453. data/lib/cybersource_rest_client/models/vas_v2_payments_post201_response_order_information_tax_details.rb +224 -0
  454. data/lib/cybersource_rest_client/models/vas_v2_payments_post201_response_tax_information.rb +194 -0
  455. data/lib/cybersource_rest_client/models/vas_v2_payments_post400_response.rb +225 -0
  456. data/lib/cybersource_rest_client/models/vas_v2_tax_void200_response.rb +237 -0
  457. data/lib/cybersource_rest_client/models/vas_v2_tax_void200_response_void_amount_details.rb +209 -0
  458. data/lib/cybersource_rest_client/models/vas_v2_tax_voids_post400_response.rb +225 -0
  459. data/lib/cybersource_rest_client/models/vasv2tax_buyer_information.rb +199 -0
  460. data/lib/cybersource_rest_client/models/vasv2tax_client_reference_information.rb +218 -0
  461. data/lib/cybersource_rest_client/models/vasv2tax_client_reference_information_partner.rb +224 -0
  462. data/lib/cybersource_rest_client/models/vasv2tax_merchant_information.rb +199 -0
  463. data/lib/cybersource_rest_client/models/vasv2tax_order_information.rb +248 -0
  464. data/lib/cybersource_rest_client/models/vasv2tax_order_information_bill_to.rb +324 -0
  465. data/lib/cybersource_rest_client/models/vasv2tax_order_information_invoice_details.rb +199 -0
  466. data/lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb +501 -0
  467. data/lib/cybersource_rest_client/models/vasv2tax_order_information_order_acceptance.rb +275 -0
  468. data/lib/cybersource_rest_client/models/vasv2tax_order_information_order_origin.rb +275 -0
  469. data/lib/cybersource_rest_client/models/vasv2tax_order_information_ship_to.rb +349 -0
  470. data/lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb +274 -0
  471. data/lib/cybersource_rest_client/models/vasv2tax_tax_information.rb +278 -0
  472. data/lib/cybersource_rest_client/models/vasv2taxid_client_reference_information.rb +218 -0
  473. data/lib/cybersource_rest_client/models/vasv2taxid_client_reference_information_partner.rb +224 -0
  474. data/lib/cybersource_rest_client/models/void_tax_request.rb +183 -0
  475. metadata +199 -110
  476. data/lib/cybersource_rest_client/api/tokenization_api.rb +0 -89
  477. data/lib/cybersource_rest_client/models/create_payment_instrument_request.rb +0 -246
  478. data/lib/cybersource_rest_client/models/error_response_with_hal.rb +0 -174
  479. data/lib/cybersource_rest_client/models/existing_instrument_identifier_id.rb +0 -175
  480. data/lib/cybersource_rest_client/models/payment_instruments_array.rb +0 -175
  481. data/lib/cybersource_rest_client/models/personal_identification_array.rb +0 -174
  482. data/lib/cybersource_rest_client/models/pi_for_ii_link_next.rb +0 -184
  483. data/lib/cybersource_rest_client/models/pi_for_ii_link_prev.rb +0 -184
  484. data/lib/cybersource_rest_client/models/processing_information.rb +0 -195
  485. data/lib/cybersource_rest_client/models/riskv1authentications_travel_information_legs.rb +0 -259
  486. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_delete409_response__links.rb +0 -183
  487. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response__embedded__links_self.rb +0 -183
  488. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response__embedded_bill_to.rb +0 -467
  489. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response__embedded_buyer_information.rb +0 -278
  490. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response__embedded_card.rb +0 -369
  491. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response__links_first.rb +0 -184
  492. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response__links_last.rb +0 -184
  493. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response__links_next.rb +0 -184
  494. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response__links_prev.rb +0 -184
  495. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response__links_self.rb +0 -184
  496. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response_bank_transfer_options.rb +0 -184
  497. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_payment_instruments_get200_response_merchant_information.rb +0 -183
  498. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_post200_response__links_self.rb +0 -183
  499. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_post200_response_authorization_options_initiator.rb +0 -183
  500. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_post200_response_issuer.rb +0 -208
  501. data/lib/cybersource_rest_client/models/tms_v1_instrument_identifiers_post200_response_processing_information.rb +0 -183
  502. data/lib/cybersource_rest_client/models/update_payment_instrument_request.rb +0 -246
@@ -14,16 +14,16 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformation
17
- # Ticket number, which consists of the carrier code, form, and serial number, without the check digit. Important This field is required in the U.S. in order for you to qualify for either the custompayment service (CPS) or the electronic interchange reimbursement fee (EIRF)program.
17
+ # Ticket number, which consists of the carrier code, form, and serial number, without the check digit. **Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only. Optional field for ancillary services.
18
18
  attr_accessor :ticket_number
19
19
 
20
- # Name of the passenger. If the passenger’s name is not available, this value is the cardholder’s name. If neither the passenger’s name nor the cardholder’s name is available,this value is a description of the ancillary purchase.Important This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program.
20
+ # Name of the passenger. If the passenger’s name is not available, this value is the cardholder’s name. If neither the passenger’s name nor the cardholder’s name is available, this value is a description of the ancillary purchase. **Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only. Optional field for ancillary service.
21
21
  attr_accessor :passenger_name
22
22
 
23
- # Name of the passenger. If the passenger’s name is not available, this value is the cardholder’s name. If neither the passenger’s name nor the cardholder’s name is available,this value is a description of the ancillary purchase. Important This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program.
23
+ # Number for the airline ticket to which the ancillary purchase is connected. If this purchase has a connection or relationship to another purchase such as a baggage fee for a passenger transport ticket, this field must contain the ticket number for the other purchase. For a stand-alone purchase, the value for this field must be the same as the value for the `travelInformation.transit.airline.ancillaryInformation.ticketNumber` field. **Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF) program. Format: English characters only. Optional request field for ancillary services.
24
24
  attr_accessor :connected_ticket_number
25
25
 
26
- # Reason for the credit. Possible values: - A: Cancellation of the ancillary passenger transport purchase. - B: Cancellation of the airline ticket and the passenger transport ancillary purchase. - C: Cancellation of the airline ticket. - O: Other. - P: Partial refund of the airline ticket. Format: English characters only.
26
+ # Reason for the credit. Possible values: - `A`: Cancellation of the ancillary passenger transport purchase. - `B`: Cancellation of the airline ticket and the passenger transport ancillary purchase. - `C`: Cancellation of the airline ticket. - `O`: Other. - `P`: Partial refund of the airline ticket. Format: English characters only. Optional field for ancillary services.
27
27
  attr_accessor :credit_reason_indicator
28
28
 
29
29
  attr_accessor :service
@@ -14,10 +14,10 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsTravelInformationTransitAirlineAncillaryInformationService
17
- # Category code for the ancillary service that is provided. Obtain the codes from the International Air Transport Association (IATA). Note is either 0, 1, 2, or 3. Important This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)program.
17
+ # Category code for the ancillary service that is provided. Obtain the codes from the International Air Transport Association (IATA). **Note** `#` is either 0, 1, 2, or 3. **Important** This field is required in the U.S. in order for you to qualify for either the custom payment service (CPS) or the electronic interchange reimbursement fee (EIRF)program. Format: English characters only. Optional request field for ancillary services.
18
18
  attr_accessor :category_code
19
19
 
20
- # Subcategory code for the ancillary service category. Obtain the codes from the International Air Transport Association (IATA). Note is 0, 1, 2, or 3. Format English characters only
20
+ # Subcategory code for the ancillary service category. Obtain the codes from the International Air Transport Association (IATA). **Note** `#` is either 0, 1, 2, or 3. Format English characters only. Optional request field for ancillary services.
21
21
  attr_accessor :sub_category_code
22
22
 
23
23
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,64 +14,64 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsTravelInformationTransitAirlineLegs
17
- # Carrier Code: IATA1 code for the carrier for this leg of the trip.
17
+ # IATA code for the carrier for this leg of the trip. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
18
18
  attr_accessor :carrier_code
19
19
 
20
- # Flight number for this leg of the trip.
20
+ # Flight number for this leg of the trip. Restrictions are limitations for the ticket based on the type of fare, such as a nonrefundable ticket or a 3-day minimum stay. Format: English characters only. Optional request field for travel legs.
21
21
  attr_accessor :flight_number
22
22
 
23
- # IATA1 code for the originating airport for this leg of the trip.
23
+ # IATA code for the originating airport for this leg of the trip. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
24
24
  attr_accessor :originating_airport_code
25
25
 
26
- # IATA1 code for the class of service for this leg of the trip.
26
+ # IATA code for the class of service for this leg of the trip. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
27
27
  attr_accessor :_class
28
28
 
29
- # Code that indicates whether a stopover is allowed on this leg of the trip. Possible Values: O(capital letter \"O\"): stopover allowed. X(capital letter \"X\"): Stopover not allowed.
29
+ # Code that indicates whether a stopover is allowed on this leg of the trip. Possible values: - `O` (capital letter O) (default): Stopover allowed - `X` (capital letter X): Stopover not allowed Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
30
30
  attr_accessor :stopover_indicator
31
31
 
32
- # Departure date for the first leg of the trip. Format: YYYYMMDD.
32
+ # Departure date for the first leg of the trip. Format: `YYYYMMDD`. Format: English characters only. Optional request field for travel legs.
33
33
  attr_accessor :departure_date
34
34
 
35
- # IATA1 code for the destination airport for this leg of the trip.
35
+ # IATA code for the destination airport for this leg of the trip. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
36
36
  attr_accessor :destination_airport_code
37
37
 
38
- # Code for the fare basis for this leg of the trip. The fare basis is assigned by the carriers and indicates a particular ticket type, such as business class or discounted/nonrefundable.
38
+ # Code for the fare basis for this leg of the trip. The fare basis is assigned by the carriers and indicates a particular ticket type, such as business class or discounted/nonrefundable. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Format: English characters only. Optional request field for travel legs.auto_rental_regular_mileage_cost
39
39
  attr_accessor :fare_basis
40
40
 
41
41
  # Amount of departure tax for this leg of the trip.
42
42
  attr_accessor :depart_tax_amount
43
43
 
44
- # Ticket that contains additional coupons for this leg of the trip on an itinerary that has more than four segments.
44
+ # Ticket that contains additional coupons for this leg of the trip on an itinerary that has more than four segments. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
45
45
  attr_accessor :conjunction_ticket
46
46
 
47
- # New ticket number that is issued when the ticket is exchanged for this leg of the trip.
47
+ # New ticket number that is issued when the ticket is exchanged for this leg of the trip. Restrictions are limitations for the ticket based on the type of fare, such as a nonrefundable ticket or a 3-day minimum stay. Format: English characters only. Optional request field for travel legs.
48
48
  attr_accessor :exchange_ticket_number
49
49
 
50
- # Each leg on the ticket requires a separate coupon, and each coupon is identified by the coupon number.
50
+ # Coupon number. Each leg on the ticket requires a separate coupon, and each coupon is identified by the coupon number. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
51
51
  attr_accessor :coupon_number
52
52
 
53
- # Time of departure for this leg of the trip. The format is military time and HHMM: If not all zeros, then the hours must be 00-23 and the minutes must be 00-59
53
+ # Time of departure for this leg of the trip. The format is military time and HHMM: If not all zeros, then the hours must be `00-23` and the minutes must be `00-59`. Format: English characters only. Optional request field for travel legs.
54
54
  attr_accessor :departure_time
55
55
 
56
- # AM or PM for the departure time. Possible values: - A: 12:00 midnight to 11:59 a.m. - P: 12:00 noon to 11:59 p.m
56
+ # AM or PM for the departure time. Possible values: - A: 12:00 midnight to 11:59 a.m. - P: 12:00 noon to 11:59 p.m Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
57
57
  attr_accessor :departure_time_meridian
58
58
 
59
- # Time of arrival for this leg of the trip. The format is military time and HHMM: If not all zeros, then the hours must be 00-23 and the minutes must be 00-59
59
+ # Time of arrival for this leg of the trip. The format is military time and HHMM: If not all zeros, then the hours must be `00-23` and the minutes must be `00-59` Format: English characters only. Optional request field for travel legs.
60
60
  attr_accessor :arrival_time
61
61
 
62
- # AM or PM for the arrival time for this leg of the trip. Possible values: - A: 12:00 midnight to 11:59 a.m. - P: 12:00 noon to 11:59 p.m. Format: English characters only
62
+ # AM or PM for the arrival time for this leg of the trip. Possible values: - `A`: 12:00 midnight to 11:59 a.m. - `P`: 12:00 noon to 11:59 p.m. Format: English characters only. Restricted string data type that indicates a sequence of letters, numbers, and spaces; special characters are not included. Optional request field for travel legs.
63
63
  attr_accessor :arrival_time_meridian
64
64
 
65
- # Notes or notations about endorsements and restrictions for this leg of the trip. Endorsements can be notations added by the travel agency, including mandatory government required notations such as value added tax. Restrictions are limitations for the ticket based on the type of fare, such as a nonrefundable tic.
65
+ # Notes or notations about endorsements and restrictions for this leg of the trip. Endorsements can be notations added by the travel agency, including mandatory government-required notations such as value added tax. Restrictions are limitations for the ticket based on the type of fare, such as a nonrefundable ticket or a 3-day minimum stay. Format: English characters only. Optional request field for travel legs.
66
66
  attr_accessor :endorsements_restrictions
67
67
 
68
- # Total fare for this leg of the trip.
68
+ # Total fare for this leg of the trip. Format: English characters only. Optional request field for travel legs.
69
69
  attr_accessor :total_fare_amount
70
70
 
71
- # Fee for this leg of the trip, such as an airport fee or country fee.
71
+ # Fee for this leg of the trip, such as an airport fee or country fee. Format: English characters only. Optional request field for travel legs.
72
72
  attr_accessor :fee_amount
73
73
 
74
- # Tax for this leg of the trip
74
+ # Tax for this leg of the trip. Format: English characters only. Optional request field for travel legs.
75
75
  attr_accessor :tax_amount
76
76
 
77
77
  # 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 Ptsv2paymentsTravelInformationTransitAirlineTicketIssuer
17
- # IATA2 airline code. Format: English characters only.
17
+ # IATA2 airline code. Format: English characters only. Required for Mastercard; optional for all other card types.
18
18
  attr_accessor :code
19
19
 
20
20
  # Name of the ticket issuer. If you do not include this field, CyberSource uses the value for your merchant name that is in the CyberSource merchant configuration database.
@@ -23,7 +23,7 @@ module CyberSource
23
23
  # Address of the company issuing the ticket.
24
24
  attr_accessor :address
25
25
 
26
- # City in which the transactionoccurred. If the name of the city exceeds 18 characters, use meaningful abbreviations. Format: English characters only
26
+ # City in which the transaction occurred. If the name of the city exceeds 18 characters, use meaningful abbreviations. Format: English characters only. Optional request field.
27
27
  attr_accessor :locality
28
28
 
29
29
  # State in which transaction occured.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidClientReferenceInformation
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/) #### 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
+ # Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by **Authorization** Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.
18
18
  attr_accessor :code
19
19
 
20
20
  attr_accessor :partner
@@ -14,13 +14,13 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidClientReferenceInformationPartner
17
- # Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the 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.
17
+ # Value that links the previous transaction to the current follow-on request. This value is assigned by the client software that is installed on the POS terminal, which makes it available to the terminal’s software and to CyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal’s software. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field.
18
18
  attr_accessor :original_transaction_id
19
19
 
20
20
  # Identifier for the developer that helped integrate a partner solution to CyberSource. Send this value in all requests that are sent through the partner solutions built by that developer. CyberSource assigns the ID to the developer. **Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.
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 solutionId of 999 in reports, the solutionId 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.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidMerchantInformation
17
- # 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)
17
+ # Date and time at your physical location. Format: `YYYYMMDDhhmmss`, where: - `YYYY` = year - `MM` = month - `DD` = day - `hh` = hour - `mm` = minutes - `ss` = seconds #### Used by **Authorization** Required for these processors: - American Express Direct - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX Optional for all other processors.
18
18
  attr_accessor :transaction_local_date_time
19
19
 
20
20
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,7 +17,7 @@ module CyberSource
17
17
  # Additional charges that have to be authorized against a lodging or auto-rental order. This value cannot be negative. You can include a decimal point (.), but no other special characters.
18
18
  attr_accessor :additional_amount
19
19
 
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/) 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).
20
+ # Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.
21
21
  attr_accessor :currency
22
22
 
23
23
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -29,7 +29,7 @@ module CyberSource
29
29
  # Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters.
30
30
  attr_accessor :postal_code
31
31
 
32
- # Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. For details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
32
+ # Sub-merchant’s country. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. For details, see the `submerchant_country` request-level field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
33
33
  attr_accessor :country
34
34
 
35
35
  # Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.
@@ -17,7 +17,7 @@ module CyberSource
17
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
- # 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)
20
+ # Customer’s government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
21
21
  attr_accessor :vat_registration_number
22
22
 
23
23
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,7 +17,7 @@ module CyberSource
17
17
  # DNS resolved hostname from `ipAddress`.
18
18
  attr_accessor :host_name
19
19
 
20
- # IP address of the customer.
20
+ # IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field.
21
21
  attr_accessor :ip_address
22
22
 
23
23
  # Customer’s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser.
@@ -22,7 +22,7 @@ module CyberSource
22
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
- # 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)
25
+ # Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
26
26
  attr_accessor :vat_registration_number
27
27
 
28
28
  attr_accessor :service_fee_descriptor
@@ -14,34 +14,34 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidcapturesOrderInformationAmountDetails
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/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice.
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/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used.
18
18
  attr_accessor :total_amount
19
19
 
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/) 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).
20
+ # Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.
21
21
  attr_accessor :currency
22
22
 
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)
23
+ # Total discount amount applied to the order.
24
24
  attr_accessor :discount_amount
25
25
 
26
- # Total charges for any import or export duties included in the order. For processor-specific information, see the duty_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)
26
+ # Total charges for any import or export duties included in the order.
27
27
  attr_accessor :duty_amount
28
28
 
29
- # Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. For information about partial authorizations, see Credit Card Services Using the SCMP API. Restaurant data is supported only on CyberSource through VisaNet.
29
+ # Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. #### Used by **Capture** Optional field. #### CyberSource through VisaNet Restaurant data is supported only on CyberSource through VisaNet.
30
30
  attr_accessor :gratuity_amount
31
31
 
32
- # Total tax amount for all the items in the order. For processor-specific information, see the total_tax_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)
32
+ # Total tax amount for all the items in the order.
33
33
  attr_accessor :tax_amount
34
34
 
35
- # Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included For processor-specific information, see the national_tax_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
35
+ # Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included
36
36
  attr_accessor :national_tax_included
37
37
 
38
- # Flag that indicates how the merchant manages discounts. Possible values: - **0**: no invoice level discount included - **1**: tax calculated on the postdiscount invoice total - **2**: tax calculated on the prediscount invoice total For processor-specific information, see the order_discount_management_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
38
+ # Flag that indicates how the merchant manages discounts. Possible values: - **0**: no invoice level discount included - **1**: tax calculated on the postdiscount invoice total - **2**: tax calculated on the prediscount invoice total
39
39
  attr_accessor :tax_applied_after_discount
40
40
 
41
- # Flag that indicates how you calculate tax. Possible values: - **0**: net prices with tax calculated at line item level - **1**: net prices with tax calculated at invoice level - **2**: gross prices with tax provided at line item level - **3**: gross prices with tax provided at invoice level - **4**: no tax applies on the invoice for the transaction For processor-specific information, see the tax_management_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
41
+ # Flag that indicates how you calculate tax. Possible values: - **0**: net prices with tax calculated at line item level - **1**: net prices with tax calculated at invoice level - **2**: gross prices with tax provided at line item level - **3**: gross prices with tax provided at invoice level - **4**: no tax applies on the invoice for the transaction
42
42
  attr_accessor :tax_applied_level
43
43
 
44
- # For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field. Possible values: - **056**: sales tax (U.S only) - **TX~**: all taxes (Canada only) Note ~ = space. For processor-specific information, see the total_tax_type_code field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
44
+ # For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field. Possible values: - **056**: sales tax (U.S only) - **TX~**: all taxes (Canada only) Note ~ = space.
45
45
  attr_accessor :tax_type_code
46
46
 
47
47
  # 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)
@@ -50,13 +50,13 @@ module CyberSource
50
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 the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
51
51
  attr_accessor :foreign_amount
52
52
 
53
- # 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/)
53
+ # Set this field to the converted amount that was returned by the DCC provider.
54
54
  attr_accessor :foreign_currency
55
55
 
56
- # Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf) For processor-specific information, see the `exchange_rate` request-level field description in [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
56
+ # Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For details, see `exchange_rate` request-level field description in the [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf)
57
57
  attr_accessor :exchange_rate
58
58
 
59
- # 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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
59
+ # Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space.
60
60
  attr_accessor :exchange_rate_time_stamp
61
61
 
62
62
  attr_accessor :amex_additional_amounts
@@ -66,10 +66,10 @@ module CyberSource
66
66
  # Service fee. Required for service fee transactions.
67
67
  attr_accessor :service_fee_amount
68
68
 
69
- # Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) 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/) 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).
69
+ # Your local pricing currency code. For the possible values, see the [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)
70
70
  attr_accessor :original_currency
71
71
 
72
- # Cashback amount requested by the customer. If a cashback amount is included in the request, it must be included in the orderInformation.amountDetails.totalAmount value.
72
+ # Cashback amount in the acquirer’s currency. If a cashback amount is included in the request, it must be included in the `orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization** Optional. **Authorization Reversal** Optional. #### PIN debit Required field for PIN debit purchase, PIN debit credit or PIN debit reversal.
73
73
  attr_accessor :cashback_amount
74
74
 
75
75
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,36 +14,36 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidcapturesOrderInformationBillTo
17
- # Customer’s first name. This name must be the same as the name on the card. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_firstname` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
17
+ # Customer’s first name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called _CyberSource Latin American Processing_. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
18
18
  attr_accessor :first_name
19
19
 
20
- # Customer’s last name. This name must be the same as the name on the card. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the `customer_lastname` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
20
+ # Customer’s last name. This name must be the same as the name on the card. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource Latin American Processing **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### RBS WorldPay Atlanta Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
21
21
  attr_accessor :last_name
22
22
 
23
23
  attr_accessor :company
24
24
 
25
- # Payment card billing street address as it appears on the credit card issuer’s records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_address1` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
25
+ # Payment card billing street address as it appears on the credit card issuer’s records. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate orderInformation.billTo.address1 and orderInformation.billTo.address2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville When the street name is numeric, it must be sent in numeric format. For example, if the address is _One First Street_, it must be sent as _1 1st Street_. Required if keyed; not used if swiped. String (20) #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional. String (60) #### For Payouts This field may be sent only for FDC Compass. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
26
26
  attr_accessor :address1
27
27
 
28
- # Additional address information. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### CyberSource through VisaNet **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `bill_address2` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
28
+ # Used for additional address information. For example: _Attention: Accounts Payable_ Optional field. For Payouts: This field may be sent only for FDC Compass. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet **Important** When you populate `orderInformation.billTo.address1` and `orderInformation.billTo.address2`, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions This value is used for AVS. #### FDMS Nashville `orderInformation.billTo.address1` and `orderInformation.billTo.address2` together cannot exceed 20 characters. String (20) #### All Other Processors String (60)
29
29
  attr_accessor :address2
30
30
 
31
- # Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the `bill_city` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
31
+ # Payment card billing city. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
32
32
  attr_accessor :locality
33
33
 
34
- # State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_state` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
34
+ # State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf). For Payouts: This field may be sent only for FDC Compass. ##### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
35
35
  attr_accessor :administrative_area
36
36
 
37
- # Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `bill_zip` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
37
+ # Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** `12345-6789` When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] **Example** `A1B 2C3` **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### For Payouts: This field may be sent only for FDC Compass. #### American Express Direct Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. #### Atos This field must not contain colons (:). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### FDMS Nashville Required if `pointOfSaleInformation.entryMode=keyed` and the address is in the U.S. or Canada. Optional if `pointOfSaleInformation.entryMode=keyed` and the address is **not** in the U.S. or Canada. Not used if swiped. #### RBS WorldPay Atlanta: For best card-present keyed rates, send the postal code if `pointOfSaleInformation.entryMode=keyed`. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### All other processors: Optional field.
38
38
  attr_accessor :postal_code
39
39
 
40
- # Payment card billing country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `bill_country` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
40
+ # Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
41
41
  attr_accessor :country
42
42
 
43
- # Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.
43
+ # Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
44
44
  attr_accessor :email
45
45
 
46
- # Customer’s phone number. #### For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.
46
+ # Customer’s phone number. It is recommended that you include the country code when the order is from outside the U.S. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. #### For Payouts: This field may be sent only for FDC Compass. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Optional field. #### Worldpay VAP Optional field. #### All other processors Not used.
47
47
  attr_accessor :phone_number
48
48
 
49
49
  # 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 Ptsv2paymentsidcapturesOrderInformationShipTo
17
- # State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada.
17
+ # State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.
18
18
  attr_accessor :administrative_area
19
19
 
20
- # Country of the shipping address. Use the two-character ISO Standard Country Codes.
20
+ # Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) Required field for authorization if any shipping address information is included in the request; otherwise, optional. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.
21
21
  attr_accessor :country
22
22
 
23
- # Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.
23
+ # Postal code for the shipping address. The postal code must consist of 5 to 9 digits. Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present.
24
24
  attr_accessor :postal_code
25
25
 
26
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -17,7 +17,7 @@ module CyberSource
17
17
  # Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for CyberSource through VisaNet (CtV). **Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - `CHECKING`: Checking account - `CREDIT`: Credit card account - `SAVING`: Saving account - `LINE_OF_CREDIT`: Line of credit or credit portion of combo card - `PREPAID`: Prepaid card account or prepaid portion of combo card - `UNIVERSAL`: Universal account
18
18
  attr_accessor :source_account_type
19
19
 
20
- # Type of account that is being used when the value for the override_payment_method field is line of credit (LI) or prepaid card (PP). Possible values for line of credit: - `AGRC`: Visa Agro Custeio - `AGRE`: Visa Agro Electron - `AGRI`: Visa Agro Investimento - `AGRO`: Visa Agro Possible values for prepaid card: - `VVA`: Visa Vale Alimentacao - `VVF`: Visa Vale Flex - `VVR`: Visa Vale Refeicao This field is supported only for combo card transactions in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: Record: CP07 TCR0, Position: 44-47, Field: Account Accessed
20
+ # Type of account that is being used when the value for the override_payment_method field is line of credit (LI) or prepaid card (PP). Possible values for line of credit: - `AGRC`: Visa Agro Custeio - `AGRE`: Visa Agro Electron - `AGRI`: Visa Agro Investimento - `AGRO`: Visa Agro Possible values for prepaid card: - `VVA`: Visa Vale Alimentacao - `VVF`: Visa Vale Flex - `VVR`: Visa Vale Refeicao This field is supported only for combo card transactions in Brazil on CyberSource through VisaNet.
21
21
  attr_accessor :source_account_type_details
22
22
 
23
23
  # 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 Ptsv2paymentsidcapturesPointOfSaleInformationEmv
17
- # EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/) **Note** The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Note** For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Important** The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram
17
+ # EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **Note** Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Important** The following tags contain sensitive information and **must not** be included in this field: - `56`: Track 1 equivalent data - `57`: Track 2 equivalent data - `5A`: Application PAN - `5F20`: Cardholder name - `5F24`: Application expiration date (This sensitivity has been relaxed for Credit Mutuel-CIC, American Express Direct, FDC Nashville Global, First Data Merchant Solutions, and SIX) - `99`: Transaction PIN - `9F0B`: Cardholder name (extended) - `9F1F`: Track 1 discretionary data - `9F20`: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - `95`: Terminal verification results - `9F10`: Issuer application data - `9F26`: Application cryptogram #### CyberSource through VisaNet - In Japan: 199 bytes - In other countries: String (252) #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### JCN Gateway The following tags must be included: - `4F`: Application identifier - `84`: Dedicated file name Data length: 199 bytes #### All other processors: String (999) #### Used by Authorization: Optional Authorization Reversal: Optional Credit: Optional PIN Debit processing (purchase, credit and reversal): Optional
18
18
  attr_accessor :tags
19
19
 
20
- # Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - **true** - **false** (default) This field is supported only on **Chase Paymentech Solutions** and **GPN**.
20
+ # Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - `true`: Fallback method was used. - `false` (default): Fallback method was not used. This field is supported only on American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet, FDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX.
21
21
  attr_accessor :fallback
22
22
 
23
23
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -26,13 +26,13 @@ module CyberSource
26
26
  # Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
27
27
  attr_accessor :report_group
28
28
 
29
- # Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. For details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/)
29
+ # Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field.
30
30
  attr_accessor :visa_checkout_id
31
31
 
32
32
  # Set this field to 3 to indicate that the request includes Level III data.
33
33
  attr_accessor :purchase_level
34
34
 
35
- # Flag that indicates that the transaction includes airline data or restaurant data. This field must be set to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor. Possible Values: - `airline` - `restaurant` - `lodging` - `auto_rental` - `transit` - `healthcare_medical` - `healthcare_transit`
35
+ # Indicates that the transaction includes industry-specific data. Possible Values: - `airline` - `restaurant` - `lodging` - `auto_rental` - `transit` - `healthcare_medical` - `healthcare_transit` - `transit` #### Card Present, Airlines and Auto Rental You must set this field to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to `airline` or is not included in the request, no airline data is sent to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to `restaurant` or is not included in the request, no restaurant data is sent to the processor. You must set this field to `auto_rental` in order for auto rental data to be sent to the processor. For example, if this field is not set to `auto_rental` or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet.
36
36
  attr_accessor :industry_data_type
37
37
 
38
38
  attr_accessor :issuer
@@ -14,13 +14,13 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions
17
- # Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). For processor-specific information, see the `auth_type` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
17
+ # Authorization type. Possible values: - `AUTOCAPTURE`: automatic capture. - `STANDARDCAPTURE`: standard capture. - `VERBAL`: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. #### Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing Set this field to `AUTOCAPTURE` and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to `STANDARDCAPTURE` and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Forced Capture Set this field to `VERBAL` and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. #### Verbal Authorization Set this field to `VERBAL` and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).
18
18
  attr_accessor :auth_type
19
19
 
20
- # Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).
20
+ # Authorization code. #### Forced Capture Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit purchase. #### Verbal Authorization Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the `auth_code` field description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).
21
21
  attr_accessor :verbal_auth_code
22
22
 
23
- # Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of `000000000000000` (15 zeros). For more information about using this default value, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
23
+ # Transaction ID (TID). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of `000000000000000` (15 zeros).
24
24
  attr_accessor :verbal_auth_transaction_id
25
25
 
26
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,7 +19,7 @@ module CyberSource
19
19
  # The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. When you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the `merchant_category_code` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code
20
20
  attr_accessor :category_code
21
21
 
22
- # 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)
22
+ # Your government-assigned tax identification number. #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes. #### CyberSource through VisaNet For CtV processors, the maximum length is 20. For other processor-specific information, see the `merchant_vat_registration_number` field description in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
23
23
  attr_accessor :vat_registration_number
24
24
 
25
25
  # 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)
@@ -14,19 +14,19 @@ require 'date'
14
14
 
15
15
  module CyberSource
16
16
  class Ptsv2paymentsidrefundsOrderInformationLineItems
17
- # Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
17
+ # Type of product. The value for this field is used to identify the product category (electronic, handling, physical, service, or shipping). The default value is `default`. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than `default` or one of the values related to shipping and/or handling, then `orderInformation.lineItems[].quantity`, `orderInformation.lineItems[].productName`, and `orderInformation.lineItems[].productSku` fields are required. Optional field. For details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. To use the tax calculation service, use values listed in the Tax Product Code Guide. For information about this document, contact customer support. See \"Product Codes,\" page 14, for more information.
18
18
  attr_accessor :product_code
19
19
 
20
- # For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.
20
+ # For an authorization or capture transaction (`processingOptions.capture` is `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes.
21
21
  attr_accessor :product_name
22
22
 
23
- # Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.
23
+ # Product identifier code. Also known as the Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to **default** or one of the other values that are related to shipping and/or handling. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the values related to shipping and/or handling.
24
24
  attr_accessor :product_sku
25
25
 
26
- # Number of units for this order. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. When orderInformation.lineItems[].productCode is \"gift_card\", this is the total count of individual prepaid gift cards purchased.
26
+ # Number of units for this order. Must be a non-negative integer. The default is `1`. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not `default` or one of the other values related to shipping and/or handling. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes.
27
27
  attr_accessor :quantity
28
28
 
29
- # Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the `amount` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. See these guides for details: - [Merchant Descriptors Using the SCMP API Guide] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) - \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
29
+ # Per-item price of the product. This value for this field cannot be negative. You must include either this field or the request-level field `orderInformation.amountDetails.totalAmount` in your request. You can include a decimal point (.), but you cannot include any other special characters. The value is truncated to the correct number of decimal places. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either the 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.] (https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/) #### Tax Calculation Required field for U.S., Canadian, international and value added taxes. #### Zero Amount Authorizations If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Maximum Field Lengths For GPN and JCN Gateway: Decimal (10) All other processors: Decimal (15)
30
30
  attr_accessor :unit_price
31
31
 
32
32
  # Unit of measure, or unit of measure code, for the item.
@@ -35,7 +35,7 @@ module CyberSource
35
35
  # Total amount for the item. Normally calculated as the unit price times quantity. When `orderInformation.lineItems[].productCode` is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD = 123
36
36
  attr_accessor :total_amount
37
37
 
38
- # Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. If you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. This field is frequently used for Level II and Level III transactions. For details, see `tax_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/)
38
+ # Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. Optional field. #### Airlines processing Tax portion of the order amount. This value cannot exceed 99999999999999 (fourteen 9s). Format: English characters only. Optional request field for a line item. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Note if you send this field in your tax request, the value in the field will override the tax engine
39
39
  attr_accessor :tax_amount
40
40
 
41
41
  # Tax rate applied to the item. For details, see `tax_rate` field description in the [Level II and Level III Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/) **Visa**: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). **Mastercard**: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).