cybersource_rest_client 0.0.62 → 0.0.64

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (308) hide show
  1. checksums.yaml +4 -4
  2. data/lib/cybersource_rest_client/api/bin_lookup_api.rb +93 -0
  3. data/lib/cybersource_rest_client/api/create_new_webhooks_api.rb +6 -6
  4. data/lib/cybersource_rest_client/api/manage_webhooks_api.rb +3 -3
  5. data/lib/cybersource_rest_client/api/merchant_boarding_api.rb +3 -3
  6. data/lib/cybersource_rest_client/api/transaction_batches_api.rb +4 -4
  7. data/lib/cybersource_rest_client/api/unified_checkout_capture_context_api.rb +2 -2
  8. data/lib/cybersource_rest_client/api_client.rb +28 -26
  9. data/lib/cybersource_rest_client/models/accountupdaterv1batches_included_tokens.rb +3 -3
  10. data/lib/cybersource_rest_client/models/{tss_v2_transactions_post400_response.rb → bin_lookupv400_response.rb} +224 -224
  11. data/lib/cybersource_rest_client/models/binv1binlookup_client_reference_information.rb +222 -0
  12. data/lib/cybersource_rest_client/models/binv1binlookup_payment_information.rb +219 -0
  13. data/lib/cybersource_rest_client/models/binv1binlookup_payment_information_card.rb +196 -0
  14. data/lib/cybersource_rest_client/models/binv1binlookup_processing_information.rb +200 -0
  15. data/lib/cybersource_rest_client/models/binv1binlookup_processing_information_payout_options.rb +213 -0
  16. data/lib/cybersource_rest_client/models/{ptsv1pushfundstransfer_processing_options_funding_options_initiator.rb → binv1binlookup_token_information.rb} +207 -196
  17. data/lib/cybersource_rest_client/models/boardingv1registrations_integration_information_oauth2.rb +3 -3
  18. data/lib/cybersource_rest_client/models/boardingv1registrations_integration_information_tenant_configurations.rb +3 -3
  19. data/lib/cybersource_rest_client/models/boardingv1registrations_organization_information_business_information.rb +3 -3
  20. data/lib/cybersource_rest_client/models/boardingv1registrations_organization_information_business_information_address.rb +9 -9
  21. data/lib/cybersource_rest_client/models/boardingv1registrations_organization_information_business_information_business_contact.rb +12 -12
  22. data/lib/cybersource_rest_client/models/boardingv1registrations_organization_information_kyc_deposit_bank_account.rb +9 -9
  23. data/lib/cybersource_rest_client/models/boardingv1registrations_organization_information_owners.rb +15 -15
  24. data/lib/cybersource_rest_client/models/case_management_comments_request.rb +3 -3
  25. data/lib/cybersource_rest_client/models/create_bin_lookup_request.rb +219 -0
  26. data/lib/cybersource_rest_client/models/create_report_subscription_request.rb +6 -6
  27. data/lib/cybersource_rest_client/models/e_check_config_common.rb +9 -9
  28. data/lib/cybersource_rest_client/models/e_check_config_common_processors.rb +3 -3
  29. data/lib/cybersource_rest_client/models/get_all_plans_response_order_information_amount_details.rb +1 -1
  30. data/lib/cybersource_rest_client/models/inline_response_200_2.rb +253 -253
  31. data/lib/cybersource_rest_client/models/inline_response_201_1.rb +248 -315
  32. data/lib/cybersource_rest_client/models/{ptsv1pushfundstransfer_aggregator_information.rb → inline_response_201_1_issuer_information.rb} +264 -223
  33. data/lib/cybersource_rest_client/models/inline_response_201_1_payment_account_information.rb +209 -0
  34. data/lib/cybersource_rest_client/models/inline_response_201_1_payment_account_information_card.rb +277 -0
  35. data/lib/cybersource_rest_client/models/{ptsv1pushfundstransfer_merchant_defined_information.rb → inline_response_201_1_payment_account_information_card_brands.rb} +213 -213
  36. data/lib/cybersource_rest_client/models/inline_response_201_1_payment_account_information_features.rb +320 -0
  37. data/lib/cybersource_rest_client/models/{ptsv1pushfundstransfer_processing_options_funding_options.rb → inline_response_201_1_payment_account_information_network.rb} +190 -189
  38. data/lib/cybersource_rest_client/models/inline_response_201_1_payout_information.rb +216 -0
  39. data/lib/cybersource_rest_client/models/inline_response_201_1_payout_information_pull_funds.rb +213 -0
  40. data/lib/cybersource_rest_client/models/inline_response_201_1_payout_information_push_funds.rb +417 -0
  41. data/lib/cybersource_rest_client/models/inline_response_201_2.rb +315 -222
  42. data/lib/cybersource_rest_client/models/{inline_response_201_1_integration_information.rb → inline_response_201_2_integration_information.rb} +192 -192
  43. data/lib/cybersource_rest_client/models/{inline_response_201_1_integration_information_tenant_configurations.rb → inline_response_201_2_integration_information_tenant_configurations.rb} +286 -286
  44. data/lib/cybersource_rest_client/models/{inline_response_201_1_organization_information.rb → inline_response_201_2_organization_information.rb} +217 -217
  45. data/lib/cybersource_rest_client/models/{inline_response_201_1_product_information_setups.rb → inline_response_201_2_product_information_setups.rb} +214 -214
  46. data/lib/cybersource_rest_client/models/{inline_response_201_1_registration_information.rb → inline_response_201_2_registration_information.rb} +256 -256
  47. data/lib/cybersource_rest_client/models/{inline_response_201_1_setups.rb → inline_response_201_2_setups.rb} +219 -219
  48. data/lib/cybersource_rest_client/models/{inline_response_201_1_setups_commerce_solutions.rb → inline_response_201_2_setups_commerce_solutions.rb} +209 -209
  49. data/lib/cybersource_rest_client/models/{inline_response_201_1_setups_payments.rb → inline_response_201_2_setups_payments.rb} +349 -349
  50. data/lib/cybersource_rest_client/models/{inline_response_201_1_setups_payments_card_processing.rb → inline_response_201_2_setups_payments_card_processing.rb} +199 -199
  51. data/lib/cybersource_rest_client/models/{inline_response_201_1_setups_payments_card_processing_configuration_status.rb → inline_response_201_2_setups_payments_card_processing_configuration_status.rb} +299 -299
  52. data/lib/cybersource_rest_client/models/{inline_response_201_1_setups_payments_card_processing_subscription_status.rb → inline_response_201_2_setups_payments_card_processing_subscription_status.rb} +278 -278
  53. data/lib/cybersource_rest_client/models/{inline_response_201_1_setups_payments_digital_payments.rb → inline_response_201_2_setups_payments_digital_payments.rb} +189 -189
  54. data/lib/cybersource_rest_client/models/{inline_response_201_1_setups_risk.rb → inline_response_201_2_setups_risk.rb} +199 -199
  55. data/lib/cybersource_rest_client/models/{inline_response_201_1_setups_value_added_services.rb → inline_response_201_2_setups_value_added_services.rb} +199 -199
  56. data/lib/cybersource_rest_client/models/inline_response_201_3.rb +222 -347
  57. data/lib/cybersource_rest_client/models/{inline_response_201_2_key_information.rb → inline_response_201_3_key_information.rb} +300 -300
  58. data/lib/cybersource_rest_client/models/{inline_response_201_2_key_information_error_information.rb → inline_response_201_3_key_information_error_information.rb} +202 -202
  59. data/lib/cybersource_rest_client/models/{inline_response_201_2_key_information_error_information_details.rb → inline_response_201_3_key_information_error_information_details.rb} +201 -201
  60. data/lib/cybersource_rest_client/models/inline_response_201_4.rb +347 -222
  61. data/lib/cybersource_rest_client/models/inline_response_201_5.rb +222 -0
  62. data/lib/cybersource_rest_client/models/invoicing_v2_invoice_settings_get200_response_invoice_settings_information.rb +1 -1
  63. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_customer_information.rb +1 -1
  64. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb +248 -248
  65. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_order_information_amount_details.rb +2 -2
  66. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_get200_response.rb +270 -270
  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 +258 -258
  69. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_post201_response_order_information_amount_details.rb +2 -2
  70. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_post202_response.rb +235 -235
  71. data/lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb +1 -1
  72. data/lib/cybersource_rest_client/models/invoicingv2invoices_customer_information.rb +2 -2
  73. data/lib/cybersource_rest_client/models/invoicingv2invoices_customer_information_company.rb +1 -1
  74. data/lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb +2 -2
  75. data/lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb +225 -225
  76. data/lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_tax_details.rb +225 -225
  77. data/lib/cybersource_rest_client/models/invoicingv2invoices_order_information_line_items.rb +333 -333
  78. data/lib/cybersource_rest_client/models/kmsv2keyssym_client_reference_information.rb +1 -1
  79. data/lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb +241 -241
  80. data/lib/cybersource_rest_client/models/patch_instrument_identifier_request.rb +2 -2
  81. data/lib/cybersource_rest_client/models/payments_products_payouts_configuration_information_configurations_processor_account.rb +3 -3
  82. data/lib/cybersource_rest_client/models/payments_products_payouts_configuration_information_configurations_pullfunds.rb +6 -6
  83. data/lib/cybersource_rest_client/models/payments_products_payouts_configuration_information_configurations_pushfunds.rb +3 -3
  84. data/lib/cybersource_rest_client/models/post_instrument_identifier_enrollment_request.rb +2 -2
  85. data/lib/cybersource_rest_client/models/post_instrument_identifier_request.rb +2 -2
  86. data/lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb +3 -3
  87. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response_credit_amount_details.rb +1 -1
  88. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response_processing_information_bank_transfer_options.rb +1 -1
  89. data/lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb +284 -284
  90. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post201_response_order_information_amount_details.rb +1 -1
  91. data/lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_buyer_information_personal_identification.rb +2 -2
  92. data/lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_order_information_amount_details.rb +1 -1
  93. data/lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_processor_information.rb +233 -233
  94. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_1_order_information_bill_to.rb +1 -1
  95. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_1_processor_information.rb +249 -249
  96. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_2_order_information_amount_details.rb +1 -1
  97. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_2_processor_information.rb +264 -264
  98. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_buyer_information.rb +3 -3
  99. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_consumer_authentication_information.rb +765 -765
  100. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb +609 -609
  101. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_issuer_information.rb +264 -264
  102. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_amount_details.rb +2 -2
  103. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb +5 -5
  104. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_bank.rb +1 -1
  105. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_bank_account.rb +1 -1
  106. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb +309 -309
  107. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_insights_information.rb +199 -189
  108. data/lib/cybersource_rest_client/models/{ptsv1pushfundstransfer_processing_information_recurring_options.rb → pts_v2_payments_post201_response_payment_insights_information_orchestration.rb} +192 -190
  109. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_insights_information_response_insights.rb +230 -230
  110. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_point_of_sale_information.rb +223 -223
  111. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processing_information.rb +217 -217
  112. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processing_information_bank_transfer_options.rb +2 -2
  113. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information.rb +736 -736
  114. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_ach_verification.rb +2 -2
  115. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_card_verification.rb +1 -1
  116. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_electronic_verification_results.rb +5 -5
  117. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_merchant_advice.rb +230 -230
  118. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_order_information_amount_details.rb +2 -2
  119. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_refund_amount_details.rb +1 -1
  120. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_issuer_information.rb +196 -196
  121. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_reversal_amount_details.rb +1 -1
  122. data/lib/cybersource_rest_client/models/pts_v2_payments_voids_post201_response_void_amount_details.rb +1 -1
  123. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_order_information_amount_details.rb +2 -2
  124. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information.rb +5 -32
  125. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb +74 -13
  126. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb +232 -310
  127. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information_payouts_options.rb +41 -23
  128. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb +18 -43
  129. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information_payment_information_card.rb +28 -1
  130. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information_personal_identification.rb +33 -7
  131. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb +27 -26
  132. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information_account.rb +10 -1
  133. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information_payment_information_card.rb +41 -5
  134. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information_personal_identification.rb +33 -7
  135. data/lib/cybersource_rest_client/models/ptsv2billingagreements_aggregator_information.rb +1 -1
  136. data/lib/cybersource_rest_client/models/ptsv2billingagreements_buyer_information.rb +247 -247
  137. data/lib/cybersource_rest_client/models/ptsv2billingagreements_client_reference_information.rb +1 -1
  138. data/lib/cybersource_rest_client/models/ptsv2billingagreements_installment_information.rb +326 -326
  139. data/lib/cybersource_rest_client/models/ptsv2billingagreements_merchant_information.rb +285 -285
  140. data/lib/cybersource_rest_client/models/ptsv2billingagreements_merchant_information_merchant_descriptor.rb +241 -241
  141. data/lib/cybersource_rest_client/models/ptsv2billingagreements_order_information_bill_to.rb +1 -1
  142. data/lib/cybersource_rest_client/models/ptsv2billingagreements_payment_information_tokenized_card.rb +275 -275
  143. data/lib/cybersource_rest_client/models/ptsv2billingagreementsid_buyer_information.rb +1 -1
  144. data/lib/cybersource_rest_client/models/ptsv2credits_installment_information.rb +196 -196
  145. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb +453 -453
  146. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb +3 -3
  147. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_buyer_information.rb +1 -1
  148. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_order_information_amount_details.rb +3 -3
  149. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_order_information_line_items.rb +361 -361
  150. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_order_information_ship_to.rb +485 -485
  151. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_payment_information_bank.rb +1 -1
  152. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_payment_information_bank_account.rb +1 -1
  153. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_payment_information_card.rb +275 -275
  154. data/lib/cybersource_rest_client/models/ptsv2payments_aggregator_information.rb +2 -2
  155. data/lib/cybersource_rest_client/models/ptsv2payments_aggregator_information_sub_merchant.rb +366 -366
  156. data/lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb +4 -4
  157. data/lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb +3 -3
  158. data/lib/cybersource_rest_client/models/ptsv2payments_client_reference_information.rb +1 -1
  159. data/lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb +1075 -1075
  160. data/lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information_strong_authentication.rb +308 -308
  161. data/lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information_strong_authentication_issuer_information.rb +196 -196
  162. data/lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb +416 -416
  163. data/lib/cybersource_rest_client/models/ptsv2payments_issuer_information.rb +196 -196
  164. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb +2 -2
  165. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information.rb +464 -464
  166. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb +405 -405
  167. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_initiated_transaction.rb +2 -2
  168. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb +641 -624
  169. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_amex_additional_amounts.rb +1 -1
  170. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_order.rb +332 -332
  171. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_tax_details.rb +286 -286
  172. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb +1 -1
  173. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to_company.rb +1 -1
  174. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb +444 -444
  175. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb +699 -699
  176. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_ship_to.rb +496 -496
  177. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb +346 -336
  178. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_bank.rb +3 -3
  179. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_bank_account.rb +2 -2
  180. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb +428 -428
  181. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_customer.rb +1 -1
  182. data/lib/cybersource_rest_client/models/{ptsv1pushfundstransfer_order_information_surcharge.rb → ptsv2payments_payment_information_payment_account_reference.rb} +196 -196
  183. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb +377 -377
  184. data/lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb +633 -633
  185. data/lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information_emv.rb +257 -257
  186. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information.rb +704 -704
  187. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb +2 -2
  188. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options_initiator.rb +1 -1
  189. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb +5 -5
  190. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_loan_options.rb +213 -213
  191. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_recurring_options.rb +205 -205
  192. data/lib/cybersource_rest_client/models/ptsv2payments_recipient_information.rb +315 -315
  193. data/lib/cybersource_rest_client/models/ptsv2payments_token_information.rb +15 -5
  194. data/lib/cybersource_rest_client/models/{tms_embedded_instrument_identifier_token_provisioning_information.rb → ptsv2payments_token_information_token_provisioning_information.rb} +1 -1
  195. data/lib/cybersource_rest_client/models/ptsv2paymentsid_order_information_amount_details.rb +1 -1
  196. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_aggregator_information.rb +2 -2
  197. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_aggregator_information_sub_merchant.rb +332 -332
  198. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_buyer_information.rb +3 -3
  199. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_buyer_information_personal_identification.rb +1 -1
  200. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb +604 -604
  201. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_merchant_information.rb +267 -267
  202. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb +5 -5
  203. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_bill_to.rb +1 -1
  204. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_invoice_details.rb +287 -287
  205. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_point_of_sale_information.rb +206 -206
  206. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information.rb +362 -362
  207. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb +2 -2
  208. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_client_reference_information.rb +1 -1
  209. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_merchant_information.rb +257 -257
  210. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_order_information_line_items.rb +502 -502
  211. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information.rb +299 -289
  212. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_bank.rb +3 -3
  213. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_bank_account.rb +1 -1
  214. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_card.rb +377 -377
  215. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb +342 -342
  216. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information_recurring_options.rb +192 -192
  217. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb +1 -1
  218. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_order_information_line_items.rb +213 -213
  219. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_processing_information.rb +287 -287
  220. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_reversal_information_amount_details.rb +2 -2
  221. data/lib/cybersource_rest_client/models/ptsv2payouts_merchant_information.rb +234 -234
  222. data/lib/cybersource_rest_client/models/ptsv2payouts_merchant_information_merchant_descriptor.rb +286 -286
  223. data/lib/cybersource_rest_client/models/ptsv2payouts_order_information_amount_details.rb +2 -2
  224. data/lib/cybersource_rest_client/models/ptsv2payouts_processing_information.rb +301 -301
  225. data/lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb +5 -39
  226. data/lib/cybersource_rest_client/models/ptsv2refreshpaymentstatusid_payment_information_customer.rb +1 -1
  227. data/lib/cybersource_rest_client/models/ptsv2voids_processing_information.rb +190 -196
  228. data/lib/cybersource_rest_client/models/push_funds201_response_order_information_amount_details.rb +4 -4
  229. data/lib/cybersource_rest_client/models/push_funds201_response_processor_information.rb +3 -37
  230. data/lib/cybersource_rest_client/models/push_funds400_response.rb +1 -1
  231. data/lib/cybersource_rest_client/models/push_funds_request.rb +5 -60
  232. data/lib/cybersource_rest_client/models/rbsv1plans_order_information_amount_details.rb +7 -7
  233. data/lib/cybersource_rest_client/models/rbsv1plans_plan_information.rb +3 -3
  234. data/lib/cybersource_rest_client/models/rbsv1subscriptions_payment_information_customer.rb +3 -3
  235. data/lib/cybersource_rest_client/models/rbsv1subscriptions_subscription_information.rb +3 -3
  236. data/lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb +1 -1
  237. data/lib/cybersource_rest_client/models/risk_v1_authentication_results_post201_response_consumer_authentication_information.rb +543 -543
  238. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb +4 -4
  239. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_order_information_amount_details.rb +1 -1
  240. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_payment_information.rb +5 -5
  241. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb +12 -12
  242. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb +290 -290
  243. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_ship_to.rb +6 -6
  244. data/lib/cybersource_rest_client/models/riskv1authenticationresults_order_information_amount_details.rb +2 -2
  245. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information_tokenized_card.rb +258 -258
  246. data/lib/cybersource_rest_client/models/riskv1authentications_buyer_information.rb +1 -1
  247. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_amount_details.rb +8 -8
  248. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_bill_to.rb +22 -22
  249. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb +497 -497
  250. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_card.rb +9 -9
  251. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_tokenized_card.rb +351 -351
  252. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_card.rb +9 -9
  253. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_fluid_data.rb +3 -3
  254. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_tokenized_card.rb +299 -299
  255. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_processing_information.rb +213 -213
  256. data/lib/cybersource_rest_client/models/riskv1decisions_buyer_information.rb +3 -3
  257. data/lib/cybersource_rest_client/models/riskv1decisions_client_reference_information.rb +3 -3
  258. data/lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb +1 -1
  259. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_amount_details.rb +223 -223
  260. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_bill_to.rb +1 -1
  261. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_line_items.rb +416 -416
  262. data/lib/cybersource_rest_client/models/riskv1decisions_payment_information_tokenized_card.rb +259 -259
  263. data/lib/cybersource_rest_client/models/riskv1decisions_processor_information_card_verification.rb +1 -1
  264. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_order_information_bill_to.rb +16 -16
  265. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_order_information_line_items.rb +314 -314
  266. data/lib/cybersource_rest_client/models/riskv1liststypeentries_client_reference_information.rb +3 -3
  267. data/lib/cybersource_rest_client/models/riskv1liststypeentries_order_information_bill_to.rb +1 -1
  268. data/lib/cybersource_rest_client/models/riskv1liststypeentries_order_information_line_items.rb +196 -196
  269. data/lib/cybersource_rest_client/models/tms_embedded_instrument_identifier.rb +2 -2
  270. data/lib/cybersource_rest_client/models/tms_embedded_instrument_identifier_bank_account.rb +207 -207
  271. data/lib/cybersource_rest_client/models/tms_embedded_instrument_identifier_tokenized_card.rb +12 -1
  272. data/lib/cybersource_rest_client/models/tms_payment_instrument_processing_info.rb +200 -200
  273. data/lib/cybersource_rest_client/models/tms_payment_instrument_processing_info_bank_transfer_options.rb +196 -196
  274. data/lib/cybersource_rest_client/models/tmsv2customers__embedded_default_payment_instrument_buyer_information.rb +236 -236
  275. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_buyer_information.rb +2 -2
  276. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_consumer_authentication_information.rb +2 -2
  277. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_amount_details.rb +3 -3
  278. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb +2 -2
  279. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_line_items.rb +292 -292
  280. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_ship_to.rb +349 -349
  281. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_bank.rb +5 -5
  282. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_bank_account.rb +2 -2
  283. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb +365 -365
  284. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_customer.rb +1 -1
  285. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb +3 -3
  286. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information_authorization_options.rb +1 -1
  287. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information_authorization_options_initiator.rb +222 -222
  288. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb +383 -383
  289. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information_electronic_verification_results.rb +4 -4
  290. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_buyer_information.rb +1 -1
  291. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_consumer_authentication_information.rb +2 -2
  292. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_order_information_bill_to.rb +1 -1
  293. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_processing_information.rb +241 -241
  294. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_risk_information_providers_fingerprint.rb +231 -231
  295. data/lib/cybersource_rest_client/models/tssv2transactionsemv_tag_details_emv_details_list.rb +6 -6
  296. data/lib/cybersource_rest_client/models/vas_v2_tax_void200_response_void_amount_details.rb +1 -1
  297. data/lib/cybersource_rest_client/models/vasv2tax_buyer_information.rb +1 -1
  298. data/lib/cybersource_rest_client/models/vasv2tax_client_reference_information.rb +1 -1
  299. data/lib/cybersource_rest_client/models/vasv2tax_merchant_information.rb +196 -196
  300. data/lib/cybersource_rest_client/models/vasv2tax_order_information_line_items.rb +403 -403
  301. data/lib/cybersource_rest_client/models/vasv2taxid_client_reference_information.rb +1 -1
  302. data/lib/cybersource_rest_client.rb +39 -30
  303. metadata +42 -33
  304. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_aggregator_information_sub_merchant.rb +0 -332
  305. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_merchant_information.rb +0 -234
  306. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_merchant_information_merchant_descriptor.rb +0 -298
  307. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_point_of_service_information.rb +0 -246
  308. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_options.rb +0 -189
@@ -1,624 +1,641 @@
1
- =begin
2
- #CyberSource Merged Spec
3
-
4
- #All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
5
-
6
- OpenAPI spec version: 0.0.1
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.38
10
- =end
11
-
12
- require 'date'
13
-
14
- module CyberSource
15
- class Ptsv2paymentsOrderInformationAmountDetails
16
- # Amount being charged as gift wrap fee.
17
- attr_accessor :gift_wrap_amount
18
-
19
- # 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.
20
- attr_accessor :total_amount
21
-
22
- # Subtotal amount of all the items.This amount (which is the value of all items in the cart, not including the additional amounts such as tax, shipping, etc.) cannot change after a sessions request. When there is a change to any of the additional amounts, this field should be resent in the order request. When the sub total amount changes, you must initiate a new transaction starting with a sessions request. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. This value can not be changed after a sessions request.
23
- attr_accessor :sub_total_amount
24
-
25
- # 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.
26
- attr_accessor :currency
27
-
28
- # Total discount amount applied to the order.
29
- attr_accessor :discount_amount
30
-
31
- # Total charges for any import or export duties included in the order.
32
- attr_accessor :duty_amount
33
-
34
- # Gratuity or tip amount for restaurants. 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 when card is present.
35
- attr_accessor :gratuity_amount
36
-
37
- # Total tax amount for all the items in the order.
38
- attr_accessor :tax_amount
39
-
40
- # Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included
41
- attr_accessor :national_tax_included
42
-
43
- # 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
44
- attr_accessor :tax_applied_after_discount
45
-
46
- # 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
47
- attr_accessor :tax_applied_level
48
-
49
- # 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.
50
- attr_accessor :tax_type_code
51
-
52
- # 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)
53
- attr_accessor :freight_amount
54
-
55
- # 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/)
56
- attr_accessor :foreign_amount
57
-
58
- # Set this field to the converted amount that was returned by the DCC provider.
59
- attr_accessor :foreign_currency
60
-
61
- # 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)
62
- attr_accessor :exchange_rate
63
-
64
- # Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space.
65
- attr_accessor :exchange_rate_time_stamp
66
-
67
- attr_accessor :surcharge
68
-
69
- # This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions.
70
- attr_accessor :settlement_amount
71
-
72
- # This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions.
73
- attr_accessor :settlement_currency
74
-
75
- attr_accessor :amex_additional_amounts
76
-
77
- attr_accessor :tax_details
78
-
79
- # Service fee. Required for service fee transactions.
80
- attr_accessor :service_fee_amount
81
-
82
- # Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places.
83
- attr_accessor :original_amount
84
-
85
- # 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)
86
- attr_accessor :original_currency
87
-
88
- # Cashback amount in the acquirer's currency. If a cashback amount is included in the request, it must be included in the `orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization** Optional. **Authorization Reversal** Optional. #### PIN debit Optional field for PIN debit purchase, PIN debit credit or PIN debit reversal.
89
- attr_accessor :cashback_amount
90
-
91
- attr_accessor :currency_conversion
92
-
93
- attr_accessor :order
94
-
95
- # Attribute mapping from ruby-style variable name to JSON key.
96
- def self.attribute_map
97
- {
98
- :'gift_wrap_amount' => :'giftWrapAmount',
99
- :'total_amount' => :'totalAmount',
100
- :'sub_total_amount' => :'subTotalAmount',
101
- :'currency' => :'currency',
102
- :'discount_amount' => :'discountAmount',
103
- :'duty_amount' => :'dutyAmount',
104
- :'gratuity_amount' => :'gratuityAmount',
105
- :'tax_amount' => :'taxAmount',
106
- :'national_tax_included' => :'nationalTaxIncluded',
107
- :'tax_applied_after_discount' => :'taxAppliedAfterDiscount',
108
- :'tax_applied_level' => :'taxAppliedLevel',
109
- :'tax_type_code' => :'taxTypeCode',
110
- :'freight_amount' => :'freightAmount',
111
- :'foreign_amount' => :'foreignAmount',
112
- :'foreign_currency' => :'foreignCurrency',
113
- :'exchange_rate' => :'exchangeRate',
114
- :'exchange_rate_time_stamp' => :'exchangeRateTimeStamp',
115
- :'surcharge' => :'surcharge',
116
- :'settlement_amount' => :'settlementAmount',
117
- :'settlement_currency' => :'settlementCurrency',
118
- :'amex_additional_amounts' => :'amexAdditionalAmounts',
119
- :'tax_details' => :'taxDetails',
120
- :'service_fee_amount' => :'serviceFeeAmount',
121
- :'original_amount' => :'originalAmount',
122
- :'original_currency' => :'originalCurrency',
123
- :'cashback_amount' => :'cashbackAmount',
124
- :'currency_conversion' => :'currencyConversion',
125
- :'order' => :'order'
126
- }
127
- end
128
-
129
- # Attribute mapping from JSON key to ruby-style variable name.
130
- def self.json_map
131
- {
132
- :'gift_wrap_amount' => :'gift_wrap_amount',
133
- :'total_amount' => :'total_amount',
134
- :'sub_total_amount' => :'sub_total_amount',
135
- :'currency' => :'currency',
136
- :'discount_amount' => :'discount_amount',
137
- :'duty_amount' => :'duty_amount',
138
- :'gratuity_amount' => :'gratuity_amount',
139
- :'tax_amount' => :'tax_amount',
140
- :'national_tax_included' => :'national_tax_included',
141
- :'tax_applied_after_discount' => :'tax_applied_after_discount',
142
- :'tax_applied_level' => :'tax_applied_level',
143
- :'tax_type_code' => :'tax_type_code',
144
- :'freight_amount' => :'freight_amount',
145
- :'foreign_amount' => :'foreign_amount',
146
- :'foreign_currency' => :'foreign_currency',
147
- :'exchange_rate' => :'exchange_rate',
148
- :'exchange_rate_time_stamp' => :'exchange_rate_time_stamp',
149
- :'surcharge' => :'surcharge',
150
- :'settlement_amount' => :'settlement_amount',
151
- :'settlement_currency' => :'settlement_currency',
152
- :'amex_additional_amounts' => :'amex_additional_amounts',
153
- :'tax_details' => :'tax_details',
154
- :'service_fee_amount' => :'service_fee_amount',
155
- :'original_amount' => :'original_amount',
156
- :'original_currency' => :'original_currency',
157
- :'cashback_amount' => :'cashback_amount',
158
- :'currency_conversion' => :'currency_conversion',
159
- :'order' => :'order'
160
- }
161
- end
162
-
163
- # Attribute type mapping.
164
- def self.swagger_types
165
- {
166
- :'gift_wrap_amount' => :'String',
167
- :'total_amount' => :'String',
168
- :'sub_total_amount' => :'String',
169
- :'currency' => :'String',
170
- :'discount_amount' => :'String',
171
- :'duty_amount' => :'String',
172
- :'gratuity_amount' => :'String',
173
- :'tax_amount' => :'String',
174
- :'national_tax_included' => :'String',
175
- :'tax_applied_after_discount' => :'String',
176
- :'tax_applied_level' => :'String',
177
- :'tax_type_code' => :'String',
178
- :'freight_amount' => :'String',
179
- :'foreign_amount' => :'String',
180
- :'foreign_currency' => :'String',
181
- :'exchange_rate' => :'String',
182
- :'exchange_rate_time_stamp' => :'String',
183
- :'surcharge' => :'Ptsv2paymentsOrderInformationAmountDetailsSurcharge',
184
- :'settlement_amount' => :'String',
185
- :'settlement_currency' => :'String',
186
- :'amex_additional_amounts' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts>',
187
- :'tax_details' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails>',
188
- :'service_fee_amount' => :'String',
189
- :'original_amount' => :'String',
190
- :'original_currency' => :'String',
191
- :'cashback_amount' => :'String',
192
- :'currency_conversion' => :'Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion',
193
- :'order' => :'Ptsv2paymentsOrderInformationAmountDetailsOrder'
194
- }
195
- end
196
-
197
- # Initializes the object
198
- # @param [Hash] attributes Model attributes in the form of hash
199
- def initialize(attributes = {})
200
- return unless attributes.is_a?(Hash)
201
-
202
- # convert string to symbol for hash key
203
- attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
204
-
205
- if attributes.has_key?(:'giftWrapAmount')
206
- self.gift_wrap_amount = attributes[:'giftWrapAmount']
207
- end
208
-
209
- if attributes.has_key?(:'totalAmount')
210
- self.total_amount = attributes[:'totalAmount']
211
- end
212
-
213
- if attributes.has_key?(:'subTotalAmount')
214
- self.sub_total_amount = attributes[:'subTotalAmount']
215
- end
216
-
217
- if attributes.has_key?(:'currency')
218
- self.currency = attributes[:'currency']
219
- end
220
-
221
- if attributes.has_key?(:'discountAmount')
222
- self.discount_amount = attributes[:'discountAmount']
223
- end
224
-
225
- if attributes.has_key?(:'dutyAmount')
226
- self.duty_amount = attributes[:'dutyAmount']
227
- end
228
-
229
- if attributes.has_key?(:'gratuityAmount')
230
- self.gratuity_amount = attributes[:'gratuityAmount']
231
- end
232
-
233
- if attributes.has_key?(:'taxAmount')
234
- self.tax_amount = attributes[:'taxAmount']
235
- end
236
-
237
- if attributes.has_key?(:'nationalTaxIncluded')
238
- self.national_tax_included = attributes[:'nationalTaxIncluded']
239
- end
240
-
241
- if attributes.has_key?(:'taxAppliedAfterDiscount')
242
- self.tax_applied_after_discount = attributes[:'taxAppliedAfterDiscount']
243
- end
244
-
245
- if attributes.has_key?(:'taxAppliedLevel')
246
- self.tax_applied_level = attributes[:'taxAppliedLevel']
247
- end
248
-
249
- if attributes.has_key?(:'taxTypeCode')
250
- self.tax_type_code = attributes[:'taxTypeCode']
251
- end
252
-
253
- if attributes.has_key?(:'freightAmount')
254
- self.freight_amount = attributes[:'freightAmount']
255
- end
256
-
257
- if attributes.has_key?(:'foreignAmount')
258
- self.foreign_amount = attributes[:'foreignAmount']
259
- end
260
-
261
- if attributes.has_key?(:'foreignCurrency')
262
- self.foreign_currency = attributes[:'foreignCurrency']
263
- end
264
-
265
- if attributes.has_key?(:'exchangeRate')
266
- self.exchange_rate = attributes[:'exchangeRate']
267
- end
268
-
269
- if attributes.has_key?(:'exchangeRateTimeStamp')
270
- self.exchange_rate_time_stamp = attributes[:'exchangeRateTimeStamp']
271
- end
272
-
273
- if attributes.has_key?(:'surcharge')
274
- self.surcharge = attributes[:'surcharge']
275
- end
276
-
277
- if attributes.has_key?(:'settlementAmount')
278
- self.settlement_amount = attributes[:'settlementAmount']
279
- end
280
-
281
- if attributes.has_key?(:'settlementCurrency')
282
- self.settlement_currency = attributes[:'settlementCurrency']
283
- end
284
-
285
- if attributes.has_key?(:'amexAdditionalAmounts')
286
- if (value = attributes[:'amexAdditionalAmounts']).is_a?(Array)
287
- self.amex_additional_amounts = value
288
- end
289
- end
290
-
291
- if attributes.has_key?(:'taxDetails')
292
- if (value = attributes[:'taxDetails']).is_a?(Array)
293
- self.tax_details = value
294
- end
295
- end
296
-
297
- if attributes.has_key?(:'serviceFeeAmount')
298
- self.service_fee_amount = attributes[:'serviceFeeAmount']
299
- end
300
-
301
- if attributes.has_key?(:'originalAmount')
302
- self.original_amount = attributes[:'originalAmount']
303
- end
304
-
305
- if attributes.has_key?(:'originalCurrency')
306
- self.original_currency = attributes[:'originalCurrency']
307
- end
308
-
309
- if attributes.has_key?(:'cashbackAmount')
310
- self.cashback_amount = attributes[:'cashbackAmount']
311
- end
312
-
313
- if attributes.has_key?(:'currencyConversion')
314
- self.currency_conversion = attributes[:'currencyConversion']
315
- end
316
-
317
- if attributes.has_key?(:'order')
318
- self.order = attributes[:'order']
319
- end
320
- end
321
-
322
- # Show invalid properties with the reasons. Usually used together with valid?
323
- # @return Array for valid properties with the reasons
324
- def list_invalid_properties
325
- invalid_properties = Array.new
326
- invalid_properties
327
- end
328
-
329
- # Check to see if the all the properties in the model are valid
330
- # @return true if the model is valid
331
- def valid?
332
- true
333
- end
334
-
335
- # Custom attribute writer method with validation
336
- # @param [Object] gift_wrap_amount Value to be assigned
337
- def gift_wrap_amount=(gift_wrap_amount)
338
- @gift_wrap_amount = gift_wrap_amount
339
- end
340
-
341
- # Custom attribute writer method with validation
342
- # @param [Object] total_amount Value to be assigned
343
- def total_amount=(total_amount)
344
- @total_amount = total_amount
345
- end
346
-
347
- # Custom attribute writer method with validation
348
- # @param [Object] sub_total_amount Value to be assigned
349
- def sub_total_amount=(sub_total_amount)
350
- @sub_total_amount = sub_total_amount
351
- end
352
-
353
- # Custom attribute writer method with validation
354
- # @param [Object] currency Value to be assigned
355
- def currency=(currency)
356
- @currency = currency
357
- end
358
-
359
- # Custom attribute writer method with validation
360
- # @param [Object] discount_amount Value to be assigned
361
- def discount_amount=(discount_amount)
362
- @discount_amount = discount_amount
363
- end
364
-
365
- # Custom attribute writer method with validation
366
- # @param [Object] duty_amount Value to be assigned
367
- def duty_amount=(duty_amount)
368
- @duty_amount = duty_amount
369
- end
370
-
371
- # Custom attribute writer method with validation
372
- # @param [Object] gratuity_amount Value to be assigned
373
- def gratuity_amount=(gratuity_amount)
374
- @gratuity_amount = gratuity_amount
375
- end
376
-
377
- # Custom attribute writer method with validation
378
- # @param [Object] tax_amount Value to be assigned
379
- def tax_amount=(tax_amount)
380
- @tax_amount = tax_amount
381
- end
382
-
383
- # Custom attribute writer method with validation
384
- # @param [Object] national_tax_included Value to be assigned
385
- def national_tax_included=(national_tax_included)
386
- @national_tax_included = national_tax_included
387
- end
388
-
389
- # Custom attribute writer method with validation
390
- # @param [Object] tax_applied_after_discount Value to be assigned
391
- def tax_applied_after_discount=(tax_applied_after_discount)
392
- @tax_applied_after_discount = tax_applied_after_discount
393
- end
394
-
395
- # Custom attribute writer method with validation
396
- # @param [Object] tax_applied_level Value to be assigned
397
- def tax_applied_level=(tax_applied_level)
398
- @tax_applied_level = tax_applied_level
399
- end
400
-
401
- # Custom attribute writer method with validation
402
- # @param [Object] tax_type_code Value to be assigned
403
- def tax_type_code=(tax_type_code)
404
- @tax_type_code = tax_type_code
405
- end
406
-
407
- # Custom attribute writer method with validation
408
- # @param [Object] freight_amount Value to be assigned
409
- def freight_amount=(freight_amount)
410
- @freight_amount = freight_amount
411
- end
412
-
413
- # Custom attribute writer method with validation
414
- # @param [Object] foreign_amount Value to be assigned
415
- def foreign_amount=(foreign_amount)
416
- @foreign_amount = foreign_amount
417
- end
418
-
419
- # Custom attribute writer method with validation
420
- # @param [Object] foreign_currency Value to be assigned
421
- def foreign_currency=(foreign_currency)
422
- @foreign_currency = foreign_currency
423
- end
424
-
425
- # Custom attribute writer method with validation
426
- # @param [Object] exchange_rate Value to be assigned
427
- def exchange_rate=(exchange_rate)
428
- @exchange_rate = exchange_rate
429
- end
430
-
431
- # Custom attribute writer method with validation
432
- # @param [Object] exchange_rate_time_stamp Value to be assigned
433
- def exchange_rate_time_stamp=(exchange_rate_time_stamp)
434
- @exchange_rate_time_stamp = exchange_rate_time_stamp
435
- end
436
-
437
- # Custom attribute writer method with validation
438
- # @param [Object] settlement_amount Value to be assigned
439
- def settlement_amount=(settlement_amount)
440
- @settlement_amount = settlement_amount
441
- end
442
-
443
- # Custom attribute writer method with validation
444
- # @param [Object] settlement_currency Value to be assigned
445
- def settlement_currency=(settlement_currency)
446
- @settlement_currency = settlement_currency
447
- end
448
-
449
- # Custom attribute writer method with validation
450
- # @param [Object] service_fee_amount Value to be assigned
451
- def service_fee_amount=(service_fee_amount)
452
- @service_fee_amount = service_fee_amount
453
- end
454
-
455
- # Custom attribute writer method with validation
456
- # @param [Object] original_amount Value to be assigned
457
- def original_amount=(original_amount)
458
- @original_amount = original_amount
459
- end
460
-
461
- # Custom attribute writer method with validation
462
- # @param [Object] original_currency Value to be assigned
463
- def original_currency=(original_currency)
464
- @original_currency = original_currency
465
- end
466
-
467
- # Custom attribute writer method with validation
468
- # @param [Object] cashback_amount Value to be assigned
469
- def cashback_amount=(cashback_amount)
470
- @cashback_amount = cashback_amount
471
- end
472
-
473
- # Checks equality by comparing each attribute.
474
- # @param [Object] Object to be compared
475
- def ==(o)
476
- return true if self.equal?(o)
477
- self.class == o.class &&
478
- gift_wrap_amount == o.gift_wrap_amount &&
479
- total_amount == o.total_amount &&
480
- sub_total_amount == o.sub_total_amount &&
481
- currency == o.currency &&
482
- discount_amount == o.discount_amount &&
483
- duty_amount == o.duty_amount &&
484
- gratuity_amount == o.gratuity_amount &&
485
- tax_amount == o.tax_amount &&
486
- national_tax_included == o.national_tax_included &&
487
- tax_applied_after_discount == o.tax_applied_after_discount &&
488
- tax_applied_level == o.tax_applied_level &&
489
- tax_type_code == o.tax_type_code &&
490
- freight_amount == o.freight_amount &&
491
- foreign_amount == o.foreign_amount &&
492
- foreign_currency == o.foreign_currency &&
493
- exchange_rate == o.exchange_rate &&
494
- exchange_rate_time_stamp == o.exchange_rate_time_stamp &&
495
- surcharge == o.surcharge &&
496
- settlement_amount == o.settlement_amount &&
497
- settlement_currency == o.settlement_currency &&
498
- amex_additional_amounts == o.amex_additional_amounts &&
499
- tax_details == o.tax_details &&
500
- service_fee_amount == o.service_fee_amount &&
501
- original_amount == o.original_amount &&
502
- original_currency == o.original_currency &&
503
- cashback_amount == o.cashback_amount &&
504
- currency_conversion == o.currency_conversion &&
505
- order == o.order
506
- end
507
-
508
- # @see the `==` method
509
- # @param [Object] Object to be compared
510
- def eql?(o)
511
- self == o
512
- end
513
-
514
- # Calculates hash code according to all attributes.
515
- # @return [Fixnum] Hash code
516
- def hash
517
- [gift_wrap_amount, total_amount, sub_total_amount, currency, discount_amount, duty_amount, gratuity_amount, tax_amount, national_tax_included, tax_applied_after_discount, tax_applied_level, tax_type_code, freight_amount, foreign_amount, foreign_currency, exchange_rate, exchange_rate_time_stamp, surcharge, settlement_amount, settlement_currency, amex_additional_amounts, tax_details, service_fee_amount, original_amount, original_currency, cashback_amount, currency_conversion, order].hash
518
- end
519
-
520
- # Builds the object from hash
521
- # @param [Hash] attributes Model attributes in the form of hash
522
- # @return [Object] Returns the model itself
523
- def build_from_hash(attributes)
524
- return nil unless attributes.is_a?(Hash)
525
- self.class.swagger_types.each_pair do |key, type|
526
- if type =~ /\AArray<(.*)>/i
527
- # check to ensure the input is an array given that the the attribute
528
- # is documented as an array but the input is not
529
- if attributes[self.class.attribute_map[key]].is_a?(Array)
530
- self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
531
- end
532
- elsif !attributes[self.class.attribute_map[key]].nil?
533
- self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
534
- end # or else data not found in attributes(hash), not an issue as the data can be optional
535
- end
536
-
537
- self
538
- end
539
-
540
- # Deserializes the data based on type
541
- # @param string type Data type
542
- # @param string value Value to be deserialized
543
- # @return [Object] Deserialized data
544
- def _deserialize(type, value)
545
- case type.to_sym
546
- when :DateTime
547
- DateTime.parse(value)
548
- when :Date
549
- Date.parse(value)
550
- when :String
551
- value.to_s
552
- when :Integer
553
- value.to_i
554
- when :Float
555
- value.to_f
556
- when :BOOLEAN
557
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
558
- true
559
- else
560
- false
561
- end
562
- when :Object
563
- # generic object (usually a Hash), return directly
564
- value
565
- when /\AArray<(?<inner_type>.+)>\z/
566
- inner_type = Regexp.last_match[:inner_type]
567
- value.map { |v| _deserialize(inner_type, v) }
568
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
569
- k_type = Regexp.last_match[:k_type]
570
- v_type = Regexp.last_match[:v_type]
571
- {}.tap do |hash|
572
- value.each do |k, v|
573
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
574
- end
575
- end
576
- else # model
577
- temp_model = CyberSource.const_get(type).new
578
- temp_model.build_from_hash(value)
579
- end
580
- end
581
-
582
- # Returns the string representation of the object
583
- # @return [String] String presentation of the object
584
- def to_s
585
- to_hash.to_s
586
- end
587
-
588
- # to_body is an alias to to_hash (backward compatibility)
589
- # @return [Hash] Returns the object in the form of hash
590
- def to_body
591
- to_hash
592
- end
593
-
594
- # Returns the object in the form of hash
595
- # @return [Hash] Returns the object in the form of hash
596
- def to_hash
597
- hash = {}
598
- self.class.attribute_map.each_pair do |attr, param|
599
- value = self.send(attr)
600
- next if value.nil?
601
- hash[param] = _to_hash(value)
602
- end
603
- hash
604
- end
605
-
606
- # Outputs non-array value in the form of hash
607
- # For object, use to_hash. Otherwise, just return the value
608
- # @param [Object] value Any valid value
609
- # @return [Hash] Returns the value in the form of hash
610
- def _to_hash(value)
611
- if value.is_a?(Array)
612
- value.compact.map { |v| _to_hash(v) }
613
- elsif value.is_a?(Hash)
614
- {}.tap do |hash|
615
- value.each { |k, v| hash[k] = _to_hash(v) }
616
- end
617
- elsif value.respond_to? :to_hash
618
- value.to_hash
619
- else
620
- value
621
- end
622
- end
623
- end
624
- end
1
+ =begin
2
+ #CyberSource Merged Spec
3
+
4
+ #All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
5
+
6
+ OpenAPI spec version: 0.0.1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.38
10
+ =end
11
+
12
+ require 'date'
13
+
14
+ module CyberSource
15
+ class Ptsv2paymentsOrderInformationAmountDetails
16
+ # Amount being charged as gift wrap fee.
17
+ attr_accessor :gift_wrap_amount
18
+
19
+ # Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. #### DCC for First Data Not used.
20
+ attr_accessor :total_amount
21
+
22
+ # Subtotal amount of all the items.This amount (which is the value of all items in the cart, not including the additional amounts such as tax, shipping, etc.) cannot change after a sessions request. When there is a change to any of the additional amounts, this field should be resent in the order request. When the sub total amount changes, you must initiate a new transaction starting with a sessions request. Note The amount value must be a non-negative number containing 2 decimal places and limited to 7 digits before the decimal point. This value can not be changed after a sessions request.
23
+ attr_accessor :sub_total_amount
24
+
25
+ # Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.
26
+ attr_accessor :currency
27
+
28
+ # Total discount amount applied to the order.
29
+ attr_accessor :discount_amount
30
+
31
+ # Total charges for any import or export duties included in the order.
32
+ attr_accessor :duty_amount
33
+
34
+ # Gratuity or tip amount for restaurants. 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 when card is present.
35
+ attr_accessor :gratuity_amount
36
+
37
+ # Total tax amount for all the items in the order.
38
+ attr_accessor :tax_amount
39
+
40
+ # Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included
41
+ attr_accessor :national_tax_included
42
+
43
+ # 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
44
+ attr_accessor :tax_applied_after_discount
45
+
46
+ # 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
47
+ attr_accessor :tax_applied_level
48
+
49
+ # 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.
50
+ attr_accessor :tax_type_code
51
+
52
+ # 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.
53
+ attr_accessor :freight_amount
54
+
55
+ # Set this field to the converted amount that was returned by the DCC provider.
56
+ attr_accessor :foreign_amount
57
+
58
+ # Set this field to the converted amount that was returned by the DCC provider.
59
+ attr_accessor :foreign_currency
60
+
61
+ # Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.
62
+ attr_accessor :exchange_rate
63
+
64
+ # Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space.
65
+ attr_accessor :exchange_rate_time_stamp
66
+
67
+ attr_accessor :surcharge
68
+
69
+ # This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder's account. This field is returned for OCT transactions.
70
+ attr_accessor :settlement_amount
71
+
72
+ # This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. This field is returned for OCT transactions.
73
+ attr_accessor :settlement_currency
74
+
75
+ attr_accessor :amex_additional_amounts
76
+
77
+ attr_accessor :tax_details
78
+
79
+ # Service fee. Required for service fee transactions.
80
+ attr_accessor :service_fee_amount
81
+
82
+ # Amount in your original local pricing currency. This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters. If needed, CyberSource truncates the amount to the correct number of decimal places.
83
+ attr_accessor :original_amount
84
+
85
+ # 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)
86
+ attr_accessor :original_currency
87
+
88
+ # Cashback amount in the acquirer's currency. If a cashback amount is included in the request, it must be included in the `orderInformation.amountDetails.totalAmount` value. This field is supported only on CyberSource through VisaNet. #### Used by **Authorization** Optional. **Authorization Reversal** Optional. #### PIN debit Optional field for PIN debit purchase, PIN debit credit or PIN debit reversal.
89
+ attr_accessor :cashback_amount
90
+
91
+ attr_accessor :currency_conversion
92
+
93
+ attr_accessor :order
94
+
95
+ # This API Field contains the anticipated amount details. This supports use cases where the Merchant does not wish to have funds held against the account, but needs to confirm an amount prior to authorization, such as for a trial subscription, reservation service, or loyalty program. In an account verification, the anticipated amount is used to confirm the account has availability to accept purchases.
96
+ attr_accessor :anticipated_amount
97
+
98
+ # Attribute mapping from ruby-style variable name to JSON key.
99
+ def self.attribute_map
100
+ {
101
+ :'gift_wrap_amount' => :'giftWrapAmount',
102
+ :'total_amount' => :'totalAmount',
103
+ :'sub_total_amount' => :'subTotalAmount',
104
+ :'currency' => :'currency',
105
+ :'discount_amount' => :'discountAmount',
106
+ :'duty_amount' => :'dutyAmount',
107
+ :'gratuity_amount' => :'gratuityAmount',
108
+ :'tax_amount' => :'taxAmount',
109
+ :'national_tax_included' => :'nationalTaxIncluded',
110
+ :'tax_applied_after_discount' => :'taxAppliedAfterDiscount',
111
+ :'tax_applied_level' => :'taxAppliedLevel',
112
+ :'tax_type_code' => :'taxTypeCode',
113
+ :'freight_amount' => :'freightAmount',
114
+ :'foreign_amount' => :'foreignAmount',
115
+ :'foreign_currency' => :'foreignCurrency',
116
+ :'exchange_rate' => :'exchangeRate',
117
+ :'exchange_rate_time_stamp' => :'exchangeRateTimeStamp',
118
+ :'surcharge' => :'surcharge',
119
+ :'settlement_amount' => :'settlementAmount',
120
+ :'settlement_currency' => :'settlementCurrency',
121
+ :'amex_additional_amounts' => :'amexAdditionalAmounts',
122
+ :'tax_details' => :'taxDetails',
123
+ :'service_fee_amount' => :'serviceFeeAmount',
124
+ :'original_amount' => :'originalAmount',
125
+ :'original_currency' => :'originalCurrency',
126
+ :'cashback_amount' => :'cashbackAmount',
127
+ :'currency_conversion' => :'currencyConversion',
128
+ :'order' => :'order',
129
+ :'anticipated_amount' => :'anticipatedAmount'
130
+ }
131
+ end
132
+
133
+ # Attribute mapping from JSON key to ruby-style variable name.
134
+ def self.json_map
135
+ {
136
+ :'gift_wrap_amount' => :'gift_wrap_amount',
137
+ :'total_amount' => :'total_amount',
138
+ :'sub_total_amount' => :'sub_total_amount',
139
+ :'currency' => :'currency',
140
+ :'discount_amount' => :'discount_amount',
141
+ :'duty_amount' => :'duty_amount',
142
+ :'gratuity_amount' => :'gratuity_amount',
143
+ :'tax_amount' => :'tax_amount',
144
+ :'national_tax_included' => :'national_tax_included',
145
+ :'tax_applied_after_discount' => :'tax_applied_after_discount',
146
+ :'tax_applied_level' => :'tax_applied_level',
147
+ :'tax_type_code' => :'tax_type_code',
148
+ :'freight_amount' => :'freight_amount',
149
+ :'foreign_amount' => :'foreign_amount',
150
+ :'foreign_currency' => :'foreign_currency',
151
+ :'exchange_rate' => :'exchange_rate',
152
+ :'exchange_rate_time_stamp' => :'exchange_rate_time_stamp',
153
+ :'surcharge' => :'surcharge',
154
+ :'settlement_amount' => :'settlement_amount',
155
+ :'settlement_currency' => :'settlement_currency',
156
+ :'amex_additional_amounts' => :'amex_additional_amounts',
157
+ :'tax_details' => :'tax_details',
158
+ :'service_fee_amount' => :'service_fee_amount',
159
+ :'original_amount' => :'original_amount',
160
+ :'original_currency' => :'original_currency',
161
+ :'cashback_amount' => :'cashback_amount',
162
+ :'currency_conversion' => :'currency_conversion',
163
+ :'order' => :'order',
164
+ :'anticipated_amount' => :'anticipated_amount'
165
+ }
166
+ end
167
+
168
+ # Attribute type mapping.
169
+ def self.swagger_types
170
+ {
171
+ :'gift_wrap_amount' => :'String',
172
+ :'total_amount' => :'String',
173
+ :'sub_total_amount' => :'String',
174
+ :'currency' => :'String',
175
+ :'discount_amount' => :'String',
176
+ :'duty_amount' => :'String',
177
+ :'gratuity_amount' => :'String',
178
+ :'tax_amount' => :'String',
179
+ :'national_tax_included' => :'String',
180
+ :'tax_applied_after_discount' => :'String',
181
+ :'tax_applied_level' => :'String',
182
+ :'tax_type_code' => :'String',
183
+ :'freight_amount' => :'String',
184
+ :'foreign_amount' => :'String',
185
+ :'foreign_currency' => :'String',
186
+ :'exchange_rate' => :'String',
187
+ :'exchange_rate_time_stamp' => :'String',
188
+ :'surcharge' => :'Ptsv2paymentsOrderInformationAmountDetailsSurcharge',
189
+ :'settlement_amount' => :'String',
190
+ :'settlement_currency' => :'String',
191
+ :'amex_additional_amounts' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts>',
192
+ :'tax_details' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails>',
193
+ :'service_fee_amount' => :'String',
194
+ :'original_amount' => :'String',
195
+ :'original_currency' => :'String',
196
+ :'cashback_amount' => :'String',
197
+ :'currency_conversion' => :'Ptsv2paymentsOrderInformationAmountDetailsCurrencyConversion',
198
+ :'order' => :'Ptsv2paymentsOrderInformationAmountDetailsOrder',
199
+ :'anticipated_amount' => :'String'
200
+ }
201
+ end
202
+
203
+ # Initializes the object
204
+ # @param [Hash] attributes Model attributes in the form of hash
205
+ def initialize(attributes = {})
206
+ return unless attributes.is_a?(Hash)
207
+
208
+ # convert string to symbol for hash key
209
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
210
+
211
+ if attributes.has_key?(:'giftWrapAmount')
212
+ self.gift_wrap_amount = attributes[:'giftWrapAmount']
213
+ end
214
+
215
+ if attributes.has_key?(:'totalAmount')
216
+ self.total_amount = attributes[:'totalAmount']
217
+ end
218
+
219
+ if attributes.has_key?(:'subTotalAmount')
220
+ self.sub_total_amount = attributes[:'subTotalAmount']
221
+ end
222
+
223
+ if attributes.has_key?(:'currency')
224
+ self.currency = attributes[:'currency']
225
+ end
226
+
227
+ if attributes.has_key?(:'discountAmount')
228
+ self.discount_amount = attributes[:'discountAmount']
229
+ end
230
+
231
+ if attributes.has_key?(:'dutyAmount')
232
+ self.duty_amount = attributes[:'dutyAmount']
233
+ end
234
+
235
+ if attributes.has_key?(:'gratuityAmount')
236
+ self.gratuity_amount = attributes[:'gratuityAmount']
237
+ end
238
+
239
+ if attributes.has_key?(:'taxAmount')
240
+ self.tax_amount = attributes[:'taxAmount']
241
+ end
242
+
243
+ if attributes.has_key?(:'nationalTaxIncluded')
244
+ self.national_tax_included = attributes[:'nationalTaxIncluded']
245
+ end
246
+
247
+ if attributes.has_key?(:'taxAppliedAfterDiscount')
248
+ self.tax_applied_after_discount = attributes[:'taxAppliedAfterDiscount']
249
+ end
250
+
251
+ if attributes.has_key?(:'taxAppliedLevel')
252
+ self.tax_applied_level = attributes[:'taxAppliedLevel']
253
+ end
254
+
255
+ if attributes.has_key?(:'taxTypeCode')
256
+ self.tax_type_code = attributes[:'taxTypeCode']
257
+ end
258
+
259
+ if attributes.has_key?(:'freightAmount')
260
+ self.freight_amount = attributes[:'freightAmount']
261
+ end
262
+
263
+ if attributes.has_key?(:'foreignAmount')
264
+ self.foreign_amount = attributes[:'foreignAmount']
265
+ end
266
+
267
+ if attributes.has_key?(:'foreignCurrency')
268
+ self.foreign_currency = attributes[:'foreignCurrency']
269
+ end
270
+
271
+ if attributes.has_key?(:'exchangeRate')
272
+ self.exchange_rate = attributes[:'exchangeRate']
273
+ end
274
+
275
+ if attributes.has_key?(:'exchangeRateTimeStamp')
276
+ self.exchange_rate_time_stamp = attributes[:'exchangeRateTimeStamp']
277
+ end
278
+
279
+ if attributes.has_key?(:'surcharge')
280
+ self.surcharge = attributes[:'surcharge']
281
+ end
282
+
283
+ if attributes.has_key?(:'settlementAmount')
284
+ self.settlement_amount = attributes[:'settlementAmount']
285
+ end
286
+
287
+ if attributes.has_key?(:'settlementCurrency')
288
+ self.settlement_currency = attributes[:'settlementCurrency']
289
+ end
290
+
291
+ if attributes.has_key?(:'amexAdditionalAmounts')
292
+ if (value = attributes[:'amexAdditionalAmounts']).is_a?(Array)
293
+ self.amex_additional_amounts = value
294
+ end
295
+ end
296
+
297
+ if attributes.has_key?(:'taxDetails')
298
+ if (value = attributes[:'taxDetails']).is_a?(Array)
299
+ self.tax_details = value
300
+ end
301
+ end
302
+
303
+ if attributes.has_key?(:'serviceFeeAmount')
304
+ self.service_fee_amount = attributes[:'serviceFeeAmount']
305
+ end
306
+
307
+ if attributes.has_key?(:'originalAmount')
308
+ self.original_amount = attributes[:'originalAmount']
309
+ end
310
+
311
+ if attributes.has_key?(:'originalCurrency')
312
+ self.original_currency = attributes[:'originalCurrency']
313
+ end
314
+
315
+ if attributes.has_key?(:'cashbackAmount')
316
+ self.cashback_amount = attributes[:'cashbackAmount']
317
+ end
318
+
319
+ if attributes.has_key?(:'currencyConversion')
320
+ self.currency_conversion = attributes[:'currencyConversion']
321
+ end
322
+
323
+ if attributes.has_key?(:'order')
324
+ self.order = attributes[:'order']
325
+ end
326
+
327
+ if attributes.has_key?(:'anticipatedAmount')
328
+ self.anticipated_amount = attributes[:'anticipatedAmount']
329
+ end
330
+ end
331
+
332
+ # Show invalid properties with the reasons. Usually used together with valid?
333
+ # @return Array for valid properties with the reasons
334
+ def list_invalid_properties
335
+ invalid_properties = Array.new
336
+ invalid_properties
337
+ end
338
+
339
+ # Check to see if the all the properties in the model are valid
340
+ # @return true if the model is valid
341
+ def valid?
342
+ true
343
+ end
344
+
345
+ # Custom attribute writer method with validation
346
+ # @param [Object] gift_wrap_amount Value to be assigned
347
+ def gift_wrap_amount=(gift_wrap_amount)
348
+ @gift_wrap_amount = gift_wrap_amount
349
+ end
350
+
351
+ # Custom attribute writer method with validation
352
+ # @param [Object] total_amount Value to be assigned
353
+ def total_amount=(total_amount)
354
+ @total_amount = total_amount
355
+ end
356
+
357
+ # Custom attribute writer method with validation
358
+ # @param [Object] sub_total_amount Value to be assigned
359
+ def sub_total_amount=(sub_total_amount)
360
+ @sub_total_amount = sub_total_amount
361
+ end
362
+
363
+ # Custom attribute writer method with validation
364
+ # @param [Object] currency Value to be assigned
365
+ def currency=(currency)
366
+ @currency = currency
367
+ end
368
+
369
+ # Custom attribute writer method with validation
370
+ # @param [Object] discount_amount Value to be assigned
371
+ def discount_amount=(discount_amount)
372
+ @discount_amount = discount_amount
373
+ end
374
+
375
+ # Custom attribute writer method with validation
376
+ # @param [Object] duty_amount Value to be assigned
377
+ def duty_amount=(duty_amount)
378
+ @duty_amount = duty_amount
379
+ end
380
+
381
+ # Custom attribute writer method with validation
382
+ # @param [Object] gratuity_amount Value to be assigned
383
+ def gratuity_amount=(gratuity_amount)
384
+ @gratuity_amount = gratuity_amount
385
+ end
386
+
387
+ # Custom attribute writer method with validation
388
+ # @param [Object] tax_amount Value to be assigned
389
+ def tax_amount=(tax_amount)
390
+ @tax_amount = tax_amount
391
+ end
392
+
393
+ # Custom attribute writer method with validation
394
+ # @param [Object] national_tax_included Value to be assigned
395
+ def national_tax_included=(national_tax_included)
396
+ @national_tax_included = national_tax_included
397
+ end
398
+
399
+ # Custom attribute writer method with validation
400
+ # @param [Object] tax_applied_after_discount Value to be assigned
401
+ def tax_applied_after_discount=(tax_applied_after_discount)
402
+ @tax_applied_after_discount = tax_applied_after_discount
403
+ end
404
+
405
+ # Custom attribute writer method with validation
406
+ # @param [Object] tax_applied_level Value to be assigned
407
+ def tax_applied_level=(tax_applied_level)
408
+ @tax_applied_level = tax_applied_level
409
+ end
410
+
411
+ # Custom attribute writer method with validation
412
+ # @param [Object] tax_type_code Value to be assigned
413
+ def tax_type_code=(tax_type_code)
414
+ @tax_type_code = tax_type_code
415
+ end
416
+
417
+ # Custom attribute writer method with validation
418
+ # @param [Object] freight_amount Value to be assigned
419
+ def freight_amount=(freight_amount)
420
+ @freight_amount = freight_amount
421
+ end
422
+
423
+ # Custom attribute writer method with validation
424
+ # @param [Object] foreign_amount Value to be assigned
425
+ def foreign_amount=(foreign_amount)
426
+ @foreign_amount = foreign_amount
427
+ end
428
+
429
+ # Custom attribute writer method with validation
430
+ # @param [Object] foreign_currency Value to be assigned
431
+ def foreign_currency=(foreign_currency)
432
+ @foreign_currency = foreign_currency
433
+ end
434
+
435
+ # Custom attribute writer method with validation
436
+ # @param [Object] exchange_rate Value to be assigned
437
+ def exchange_rate=(exchange_rate)
438
+ @exchange_rate = exchange_rate
439
+ end
440
+
441
+ # Custom attribute writer method with validation
442
+ # @param [Object] exchange_rate_time_stamp Value to be assigned
443
+ def exchange_rate_time_stamp=(exchange_rate_time_stamp)
444
+ @exchange_rate_time_stamp = exchange_rate_time_stamp
445
+ end
446
+
447
+ # Custom attribute writer method with validation
448
+ # @param [Object] settlement_amount Value to be assigned
449
+ def settlement_amount=(settlement_amount)
450
+ @settlement_amount = settlement_amount
451
+ end
452
+
453
+ # Custom attribute writer method with validation
454
+ # @param [Object] settlement_currency Value to be assigned
455
+ def settlement_currency=(settlement_currency)
456
+ @settlement_currency = settlement_currency
457
+ end
458
+
459
+ # Custom attribute writer method with validation
460
+ # @param [Object] service_fee_amount Value to be assigned
461
+ def service_fee_amount=(service_fee_amount)
462
+ @service_fee_amount = service_fee_amount
463
+ end
464
+
465
+ # Custom attribute writer method with validation
466
+ # @param [Object] original_amount Value to be assigned
467
+ def original_amount=(original_amount)
468
+ @original_amount = original_amount
469
+ end
470
+
471
+ # Custom attribute writer method with validation
472
+ # @param [Object] original_currency Value to be assigned
473
+ def original_currency=(original_currency)
474
+ @original_currency = original_currency
475
+ end
476
+
477
+ # Custom attribute writer method with validation
478
+ # @param [Object] cashback_amount Value to be assigned
479
+ def cashback_amount=(cashback_amount)
480
+ @cashback_amount = cashback_amount
481
+ end
482
+
483
+ # Custom attribute writer method with validation
484
+ # @param [Object] anticipated_amount Value to be assigned
485
+ def anticipated_amount=(anticipated_amount)
486
+ @anticipated_amount = anticipated_amount
487
+ end
488
+
489
+ # Checks equality by comparing each attribute.
490
+ # @param [Object] Object to be compared
491
+ def ==(o)
492
+ return true if self.equal?(o)
493
+ self.class == o.class &&
494
+ gift_wrap_amount == o.gift_wrap_amount &&
495
+ total_amount == o.total_amount &&
496
+ sub_total_amount == o.sub_total_amount &&
497
+ currency == o.currency &&
498
+ discount_amount == o.discount_amount &&
499
+ duty_amount == o.duty_amount &&
500
+ gratuity_amount == o.gratuity_amount &&
501
+ tax_amount == o.tax_amount &&
502
+ national_tax_included == o.national_tax_included &&
503
+ tax_applied_after_discount == o.tax_applied_after_discount &&
504
+ tax_applied_level == o.tax_applied_level &&
505
+ tax_type_code == o.tax_type_code &&
506
+ freight_amount == o.freight_amount &&
507
+ foreign_amount == o.foreign_amount &&
508
+ foreign_currency == o.foreign_currency &&
509
+ exchange_rate == o.exchange_rate &&
510
+ exchange_rate_time_stamp == o.exchange_rate_time_stamp &&
511
+ surcharge == o.surcharge &&
512
+ settlement_amount == o.settlement_amount &&
513
+ settlement_currency == o.settlement_currency &&
514
+ amex_additional_amounts == o.amex_additional_amounts &&
515
+ tax_details == o.tax_details &&
516
+ service_fee_amount == o.service_fee_amount &&
517
+ original_amount == o.original_amount &&
518
+ original_currency == o.original_currency &&
519
+ cashback_amount == o.cashback_amount &&
520
+ currency_conversion == o.currency_conversion &&
521
+ order == o.order &&
522
+ anticipated_amount == o.anticipated_amount
523
+ end
524
+
525
+ # @see the `==` method
526
+ # @param [Object] Object to be compared
527
+ def eql?(o)
528
+ self == o
529
+ end
530
+
531
+ # Calculates hash code according to all attributes.
532
+ # @return [Fixnum] Hash code
533
+ def hash
534
+ [gift_wrap_amount, total_amount, sub_total_amount, currency, discount_amount, duty_amount, gratuity_amount, tax_amount, national_tax_included, tax_applied_after_discount, tax_applied_level, tax_type_code, freight_amount, foreign_amount, foreign_currency, exchange_rate, exchange_rate_time_stamp, surcharge, settlement_amount, settlement_currency, amex_additional_amounts, tax_details, service_fee_amount, original_amount, original_currency, cashback_amount, currency_conversion, order, anticipated_amount].hash
535
+ end
536
+
537
+ # Builds the object from hash
538
+ # @param [Hash] attributes Model attributes in the form of hash
539
+ # @return [Object] Returns the model itself
540
+ def build_from_hash(attributes)
541
+ return nil unless attributes.is_a?(Hash)
542
+ self.class.swagger_types.each_pair do |key, type|
543
+ if type =~ /\AArray<(.*)>/i
544
+ # check to ensure the input is an array given that the the attribute
545
+ # is documented as an array but the input is not
546
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
547
+ self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
548
+ end
549
+ elsif !attributes[self.class.attribute_map[key]].nil?
550
+ self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
551
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
552
+ end
553
+
554
+ self
555
+ end
556
+
557
+ # Deserializes the data based on type
558
+ # @param string type Data type
559
+ # @param string value Value to be deserialized
560
+ # @return [Object] Deserialized data
561
+ def _deserialize(type, value)
562
+ case type.to_sym
563
+ when :DateTime
564
+ DateTime.parse(value)
565
+ when :Date
566
+ Date.parse(value)
567
+ when :String
568
+ value.to_s
569
+ when :Integer
570
+ value.to_i
571
+ when :Float
572
+ value.to_f
573
+ when :BOOLEAN
574
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
575
+ true
576
+ else
577
+ false
578
+ end
579
+ when :Object
580
+ # generic object (usually a Hash), return directly
581
+ value
582
+ when /\AArray<(?<inner_type>.+)>\z/
583
+ inner_type = Regexp.last_match[:inner_type]
584
+ value.map { |v| _deserialize(inner_type, v) }
585
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
586
+ k_type = Regexp.last_match[:k_type]
587
+ v_type = Regexp.last_match[:v_type]
588
+ {}.tap do |hash|
589
+ value.each do |k, v|
590
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
591
+ end
592
+ end
593
+ else # model
594
+ temp_model = CyberSource.const_get(type).new
595
+ temp_model.build_from_hash(value)
596
+ end
597
+ end
598
+
599
+ # Returns the string representation of the object
600
+ # @return [String] String presentation of the object
601
+ def to_s
602
+ to_hash.to_s
603
+ end
604
+
605
+ # to_body is an alias to to_hash (backward compatibility)
606
+ # @return [Hash] Returns the object in the form of hash
607
+ def to_body
608
+ to_hash
609
+ end
610
+
611
+ # Returns the object in the form of hash
612
+ # @return [Hash] Returns the object in the form of hash
613
+ def to_hash
614
+ hash = {}
615
+ self.class.attribute_map.each_pair do |attr, param|
616
+ value = self.send(attr)
617
+ next if value.nil?
618
+ hash[param] = _to_hash(value)
619
+ end
620
+ hash
621
+ end
622
+
623
+ # Outputs non-array value in the form of hash
624
+ # For object, use to_hash. Otherwise, just return the value
625
+ # @param [Object] value Any valid value
626
+ # @return [Hash] Returns the value in the form of hash
627
+ def _to_hash(value)
628
+ if value.is_a?(Array)
629
+ value.compact.map { |v| _to_hash(v) }
630
+ elsif value.is_a?(Hash)
631
+ {}.tap do |hash|
632
+ value.each { |k, v| hash[k] = _to_hash(v) }
633
+ end
634
+ elsif value.respond_to? :to_hash
635
+ value.to_hash
636
+ else
637
+ value
638
+ end
639
+ end
640
+ end
641
+ end