cybersource_rest_client 0.0.61 → 0.0.63

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 (196) hide show
  1. checksums.yaml +4 -4
  2. data/lib/cybersource_rest_client/api/invoices_api.rb +2 -2
  3. data/lib/cybersource_rest_client/api/transaction_batches_api.rb +4 -4
  4. data/lib/cybersource_rest_client/api/transient_token_data_api.rb +9 -9
  5. data/lib/cybersource_rest_client/models/accountupdaterv1batches_included_tokens.rb +3 -3
  6. data/lib/cybersource_rest_client/models/boardingv1registrations_integration_information_oauth2.rb +3 -3
  7. data/lib/cybersource_rest_client/models/boardingv1registrations_integration_information_tenant_configurations.rb +3 -3
  8. data/lib/cybersource_rest_client/models/boardingv1registrations_organization_information_business_information.rb +3 -3
  9. data/lib/cybersource_rest_client/models/boardingv1registrations_organization_information_business_information_address.rb +9 -9
  10. data/lib/cybersource_rest_client/models/boardingv1registrations_organization_information_business_information_business_contact.rb +12 -12
  11. data/lib/cybersource_rest_client/models/boardingv1registrations_organization_information_kyc_deposit_bank_account.rb +9 -9
  12. data/lib/cybersource_rest_client/models/boardingv1registrations_organization_information_owners.rb +15 -15
  13. data/lib/cybersource_rest_client/models/case_management_comments_request.rb +3 -3
  14. data/lib/cybersource_rest_client/models/create_report_subscription_request.rb +6 -6
  15. data/lib/cybersource_rest_client/models/e_check_config_common.rb +9 -9
  16. data/lib/cybersource_rest_client/models/e_check_config_common_processors.rb +3 -3
  17. data/lib/cybersource_rest_client/models/get_all_plans_response_order_information_amount_details.rb +1 -1
  18. data/lib/cybersource_rest_client/models/invoicing_v2_invoice_settings_get200_response_invoice_settings_information.rb +1 -1
  19. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_customer_information.rb +1 -1
  20. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_invoices.rb +1 -1
  21. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_all_get200_response_order_information_amount_details.rb +2 -2
  22. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_get200_response.rb +1 -1
  23. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_get200_response_transaction_details.rb +1 -1
  24. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_post201_response.rb +1 -1
  25. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_post201_response_order_information_amount_details.rb +2 -2
  26. data/lib/cybersource_rest_client/models/invoicing_v2_invoices_post202_response.rb +1 -1
  27. data/lib/cybersource_rest_client/models/invoicingv2invoice_settings_invoice_settings_information.rb +1 -1
  28. data/lib/cybersource_rest_client/models/invoicingv2invoices_customer_information.rb +2 -2
  29. data/lib/cybersource_rest_client/models/invoicingv2invoices_customer_information_company.rb +1 -1
  30. data/lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb +2 -2
  31. data/lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details_freight.rb +1 -1
  32. data/lib/cybersource_rest_client/models/kmsv2keyssym_client_reference_information.rb +1 -1
  33. data/lib/cybersource_rest_client/models/patch_instrument_identifier_request.rb +2 -2
  34. data/lib/cybersource_rest_client/models/payments_products_payouts_configuration_information_configurations_processor_account.rb +3 -3
  35. data/lib/cybersource_rest_client/models/payments_products_payouts_configuration_information_configurations_pullfunds.rb +6 -6
  36. data/lib/cybersource_rest_client/models/payments_products_payouts_configuration_information_configurations_pushfunds.rb +3 -3
  37. data/lib/cybersource_rest_client/models/post_instrument_identifier_enrollment_request.rb +2 -2
  38. data/lib/cybersource_rest_client/models/post_instrument_identifier_request.rb +2 -2
  39. data/lib/cybersource_rest_client/models/predefined_subscription_request_bean.rb +3 -3
  40. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response_credit_amount_details.rb +1 -1
  41. data/lib/cybersource_rest_client/models/pts_v2_credits_post201_response_processing_information_bank_transfer_options.rb +1 -1
  42. data/lib/cybersource_rest_client/models/pts_v2_payments_captures_post201_response_order_information_amount_details.rb +1 -1
  43. data/lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_buyer_information_personal_identification.rb +2 -2
  44. data/lib/cybersource_rest_client/models/pts_v2_payments_order_post201_response_order_information_amount_details.rb +1 -1
  45. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_1_order_information_bill_to.rb +1 -1
  46. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_2_order_information_amount_details.rb +1 -1
  47. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_buyer_information.rb +3 -3
  48. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_consumer_authentication_information.rb +3 -3
  49. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_order_information_amount_details.rb +2 -2
  50. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb +5 -5
  51. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_bank.rb +1 -1
  52. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_bank_account.rb +1 -1
  53. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processing_information_bank_transfer_options.rb +2 -2
  54. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_ach_verification.rb +2 -2
  55. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_card_verification.rb +1 -1
  56. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_processor_information_electronic_verification_results.rb +5 -5
  57. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_order_information_amount_details.rb +2 -2
  58. data/lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_refund_amount_details.rb +1 -1
  59. data/lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_reversal_amount_details.rb +1 -1
  60. data/lib/cybersource_rest_client/models/pts_v2_payments_voids_post201_response_void_amount_details.rb +1 -1
  61. data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_order_information_amount_details.rb +2 -2
  62. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information.rb +5 -32
  63. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_amount_details.rb +74 -13
  64. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information.rb +14 -109
  65. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information_payouts_options.rb +41 -23
  66. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information.rb +18 -43
  67. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information_payment_information_card.rb +28 -1
  68. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_recipient_information_personal_identification.rb +33 -7
  69. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information.rb +27 -26
  70. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information_account.rb +10 -1
  71. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information_payment_information_card.rb +41 -5
  72. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_sender_information_personal_identification.rb +33 -7
  73. data/lib/cybersource_rest_client/models/ptsv2billingagreements_aggregator_information.rb +1 -1
  74. data/lib/cybersource_rest_client/models/ptsv2billingagreements_buyer_information.rb +1 -1
  75. data/lib/cybersource_rest_client/models/ptsv2billingagreements_client_reference_information.rb +1 -1
  76. data/lib/cybersource_rest_client/models/ptsv2billingagreements_order_information_bill_to.rb +1 -1
  77. data/lib/cybersource_rest_client/models/ptsv2billingagreementsid_buyer_information.rb +1 -1
  78. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb +3 -3
  79. data/lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb +3 -3
  80. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_buyer_information.rb +1 -1
  81. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_order_information_amount_details.rb +3 -3
  82. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_payment_information_bank.rb +1 -1
  83. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_payment_information_bank_account.rb +1 -1
  84. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_payment_information_card.rb +1 -1
  85. data/lib/cybersource_rest_client/models/ptsv2payments_aggregator_information.rb +2 -2
  86. data/lib/cybersource_rest_client/models/ptsv2payments_buyer_information.rb +4 -4
  87. data/lib/cybersource_rest_client/models/ptsv2payments_buyer_information_personal_identification.rb +3 -3
  88. data/lib/cybersource_rest_client/models/ptsv2payments_client_reference_information.rb +1 -1
  89. data/lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information.rb +7 -7
  90. data/lib/cybersource_rest_client/models/ptsv2payments_consumer_authentication_information_strong_authentication.rb +11 -1
  91. data/lib/cybersource_rest_client/models/{ptsv1pushfundstransfer_processing_options_funding_options_initiator.rb → ptsv2payments_consumer_authentication_information_strong_authentication_issuer_information.rb} +13 -13
  92. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_defined_information.rb +2 -2
  93. data/lib/cybersource_rest_client/models/ptsv2payments_merchant_initiated_transaction.rb +2 -2
  94. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb +5 -5
  95. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details_amex_additional_amounts.rb +1 -1
  96. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to.rb +1 -1
  97. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_bill_to_company.rb +1 -1
  98. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_bank.rb +3 -3
  99. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_bank_account.rb +2 -2
  100. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb +1 -1
  101. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_customer.rb +1 -1
  102. data/lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information_emv.rb +1 -1
  103. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information.rb +5 -5
  104. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options.rb +2 -2
  105. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_authorization_options_initiator.rb +1 -1
  106. data/lib/cybersource_rest_client/models/ptsv2payments_processing_information_bank_transfer_options.rb +5 -5
  107. data/lib/cybersource_rest_client/models/ptsv2payments_token_information.rb +15 -5
  108. data/lib/cybersource_rest_client/models/{tms_embedded_instrument_identifier_token_provisioning_information.rb → ptsv2payments_token_information_token_provisioning_information.rb} +1 -1
  109. data/lib/cybersource_rest_client/models/ptsv2paymentsid_order_information_amount_details.rb +1 -1
  110. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_aggregator_information.rb +2 -2
  111. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_buyer_information.rb +3 -3
  112. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_buyer_information_personal_identification.rb +1 -1
  113. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_amount_details.rb +5 -5
  114. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_order_information_bill_to.rb +1 -1
  115. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information.rb +2 -2
  116. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_processing_information_authorization_options.rb +2 -2
  117. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_client_reference_information.rb +1 -1
  118. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_bank.rb +3 -3
  119. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_bank_account.rb +1 -1
  120. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_card.rb +1 -1
  121. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_processing_information.rb +2 -2
  122. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_client_reference_information.rb +1 -1
  123. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_processing_information.rb +2 -2
  124. data/lib/cybersource_rest_client/models/ptsv2paymentsidreversals_reversal_information_amount_details.rb +2 -2
  125. data/lib/cybersource_rest_client/models/ptsv2payouts_order_information_amount_details.rb +2 -2
  126. data/lib/cybersource_rest_client/models/ptsv2payouts_recipient_information.rb +5 -39
  127. data/lib/cybersource_rest_client/models/ptsv2refreshpaymentstatusid_payment_information_customer.rb +1 -1
  128. data/lib/cybersource_rest_client/models/push_funds201_response_order_information_amount_details.rb +4 -4
  129. data/lib/cybersource_rest_client/models/push_funds201_response_processor_information.rb +3 -37
  130. data/lib/cybersource_rest_client/models/push_funds400_response.rb +1 -1
  131. data/lib/cybersource_rest_client/models/push_funds_request.rb +5 -60
  132. data/lib/cybersource_rest_client/models/rbsv1plans_order_information_amount_details.rb +7 -7
  133. data/lib/cybersource_rest_client/models/rbsv1plans_plan_information.rb +3 -3
  134. data/lib/cybersource_rest_client/models/rbsv1subscriptions_payment_information_customer.rb +3 -3
  135. data/lib/cybersource_rest_client/models/rbsv1subscriptions_subscription_information.rb +3 -3
  136. data/lib/cybersource_rest_client/models/risk_v1_address_verifications_post201_response_address_verification_information.rb +1 -1
  137. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_consumer_authentication_information.rb +21 -4
  138. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_order_information_amount_details.rb +1 -1
  139. data/lib/cybersource_rest_client/models/risk_v1_decisions_post201_response_payment_information.rb +5 -5
  140. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_bill_to.rb +12 -12
  141. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_line_items.rb +3 -3
  142. data/lib/cybersource_rest_client/models/riskv1addressverifications_order_information_ship_to.rb +6 -6
  143. data/lib/cybersource_rest_client/models/riskv1authenticationresults_order_information_amount_details.rb +2 -2
  144. data/lib/cybersource_rest_client/models/riskv1authentications_buyer_information.rb +1 -1
  145. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_amount_details.rb +8 -8
  146. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_bill_to.rb +22 -22
  147. data/lib/cybersource_rest_client/models/riskv1authentications_order_information_line_items.rb +3 -3
  148. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_card.rb +9 -9
  149. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_tokenized_card.rb +18 -18
  150. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_card.rb +9 -9
  151. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_fluid_data.rb +3 -3
  152. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_tokenized_card.rb +12 -12
  153. data/lib/cybersource_rest_client/models/riskv1decisions_buyer_information.rb +3 -3
  154. data/lib/cybersource_rest_client/models/riskv1decisions_client_reference_information.rb +3 -3
  155. data/lib/cybersource_rest_client/models/riskv1decisions_consumer_authentication_information.rb +1 -1
  156. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_amount_details.rb +4 -4
  157. data/lib/cybersource_rest_client/models/riskv1decisions_order_information_bill_to.rb +1 -1
  158. data/lib/cybersource_rest_client/models/riskv1decisions_processor_information_card_verification.rb +1 -1
  159. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_order_information_bill_to.rb +16 -16
  160. data/lib/cybersource_rest_client/models/riskv1exportcomplianceinquiries_order_information_line_items.rb +3 -3
  161. data/lib/cybersource_rest_client/models/riskv1liststypeentries_client_reference_information.rb +3 -3
  162. data/lib/cybersource_rest_client/models/riskv1liststypeentries_order_information_bill_to.rb +1 -1
  163. data/lib/cybersource_rest_client/models/tms_embedded_instrument_identifier.rb +2 -2
  164. data/lib/cybersource_rest_client/models/tms_embedded_instrument_identifier_tokenized_card.rb +12 -1
  165. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_buyer_information.rb +2 -2
  166. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_consumer_authentication_information.rb +2 -2
  167. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_amount_details.rb +3 -3
  168. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_bill_to.rb +2 -2
  169. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_bank.rb +5 -5
  170. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_bank_account.rb +2 -2
  171. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb +1 -1
  172. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_customer.rb +1 -1
  173. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information.rb +3 -3
  174. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processing_information_authorization_options.rb +1 -1
  175. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information_electronic_verification_results.rb +4 -4
  176. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_buyer_information.rb +1 -1
  177. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_consumer_authentication_information.rb +2 -2
  178. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_order_information_bill_to.rb +1 -1
  179. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_processing_information.rb +3 -3
  180. data/lib/cybersource_rest_client/models/tssv2transactionsemv_tag_details_emv_details_list.rb +6 -6
  181. data/lib/cybersource_rest_client/models/vas_v2_tax_void200_response_void_amount_details.rb +1 -1
  182. data/lib/cybersource_rest_client/models/vasv2tax_buyer_information.rb +1 -1
  183. data/lib/cybersource_rest_client/models/vasv2tax_client_reference_information.rb +1 -1
  184. data/lib/cybersource_rest_client/models/vasv2taxid_client_reference_information.rb +1 -1
  185. data/lib/cybersource_rest_client.rb +2 -12
  186. metadata +4 -14
  187. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_aggregator_information.rb +0 -223
  188. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_aggregator_information_sub_merchant.rb +0 -332
  189. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_merchant_defined_information.rb +0 -213
  190. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_merchant_information.rb +0 -234
  191. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_merchant_information_merchant_descriptor.rb +0 -298
  192. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_order_information_surcharge.rb +0 -196
  193. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_point_of_service_information.rb +0 -246
  194. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_information_recurring_options.rb +0 -190
  195. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_options.rb +0 -189
  196. data/lib/cybersource_rest_client/models/ptsv1pushfundstransfer_processing_options_funding_options.rb +0 -189
@@ -16,7 +16,7 @@ module CyberSource
16
16
  # Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` **Example** `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. Returned by Cybersource for all services.
17
17
  attr_accessor :submit_time_utc
18
18
 
19
- # The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED
19
+ # The status of the invoice. Possible values: - DRAFT - CREATED - SENT - PARTIAL - PAID - CANCELED - PENDING
20
20
  attr_accessor :status
21
21
 
22
22
  # The reason of the status. Possible values: - ACCEPTED
@@ -30,7 +30,7 @@ module CyberSource
30
30
  # The language of the email that we send to your customers. Possible values are `zh-CN`, `zh-TW`, `en-US`, `fr-FR`, `de-DE`, `ja-JP`, `pt-BR`, `ru-RU` and `es-419`.
31
31
  attr_accessor :delivery_language
32
32
 
33
- # 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.
33
+ # 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.
34
34
  attr_accessor :default_currency_code
35
35
 
36
36
  # For a merchant's invoice payments, enable 3D Secure payer authentication version 1, update to 3D Secure version 2, or disable 3D Secure. Possible values are: - `enable` - `update` - `disable`
@@ -17,10 +17,10 @@ module CyberSource
17
17
  # Payer name for the invoice.
18
18
  attr_accessor :name
19
19
 
20
- # Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
20
+ # Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
21
21
  attr_accessor :email
22
22
 
23
- # Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
23
+ # Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used.
24
24
  attr_accessor :merchant_customer_id
25
25
 
26
26
  attr_accessor :company
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class Invoicingv2invoicesCustomerInformationCompany
16
- # Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the `company_name` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
16
+ # Name of the customer's company. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.
17
17
  attr_accessor :name
18
18
 
19
19
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,10 +14,10 @@ require 'date'
14
14
  module CyberSource
15
15
  # Contains all of the amount-related fields in the invoice.
16
16
  class Invoicingv2invoicesOrderInformationAmountDetails
17
- # Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/). If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order. #### Invoicing Required for creating a new invoice. #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required. #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/) #### DCC for First Data Not used.
17
+ # Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. 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.
18
18
  attr_accessor :total_amount
19
19
 
20
- # Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.
20
+ # Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) #### Used by **Authorization** Required field. **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request. #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase. For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests. #### GPX This field is optional for reversing an authorization or credit. #### DCC for First Data Your local currency. #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency.
21
21
  attr_accessor :currency
22
22
 
23
23
  # Total discount amount applied to the order.
@@ -14,7 +14,7 @@ require 'date'
14
14
  module CyberSource
15
15
  # Contains all of the shipping-related fields for the invoice.
16
16
  class Invoicingv2invoicesOrderInformationAmountDetailsFreight
17
- # 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)
17
+ # 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.
18
18
  attr_accessor :amount
19
19
 
20
20
  # Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0. If you do not include any `lineItems[].taxAmount` values in your request, CyberSource does not include `invoiceDetails.taxable` in the data it sends to the processor. For processor-specific information, see the `tax_indicator` field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) Possible values: - **true** - **false**
@@ -16,7 +16,7 @@ module CyberSource
16
16
  # Client-generated order reference or tracking number. CyberSource recommends that you send a unique value.
17
17
  attr_accessor :code
18
18
 
19
- # Comments
19
+ # Brief description of the order or any comment you wish to add to the order.
20
20
  attr_accessor :comments
21
21
 
22
22
  attr_accessor :partner
@@ -24,7 +24,7 @@ module CyberSource
24
24
  # Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed.
25
25
  attr_accessor :state
26
26
 
27
- # The type of Instrument Identifier. Possible Values: - enrollable card
27
+ # The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token
28
28
  attr_accessor :type
29
29
 
30
30
  attr_accessor :token_provisioning_information
@@ -89,7 +89,7 @@ module CyberSource
89
89
  :'object' => :'String',
90
90
  :'state' => :'String',
91
91
  :'type' => :'String',
92
- :'token_provisioning_information' => :'TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation',
92
+ :'token_provisioning_information' => :'Ptsv2paymentsTokenInformationTokenProvisioningInformation',
93
93
  :'card' => :'TmsEmbeddedInstrumentIdentifierCard',
94
94
  :'bank_account' => :'TmsEmbeddedInstrumentIdentifierBankAccount',
95
95
  :'tokenized_card' => :'TmsEmbeddedInstrumentIdentifierTokenizedCard',
@@ -100,9 +100,9 @@ module CyberSource
100
100
  # Custom attribute writer method with validation
101
101
  # @param [Object] originator_merchant_id Value to be assigned
102
102
  def originator_merchant_id=(originator_merchant_id)
103
- if originator_merchant_id.nil?
104
- fail ArgumentError, 'originator_merchant_id cannot be nil'
105
- end
103
+ #if originator_merchant_id.nil?
104
+ #fail ArgumentError, 'originator_merchant_id cannot be nil'
105
+ #end
106
106
 
107
107
  @originator_merchant_id = originator_merchant_id
108
108
  end
@@ -148,9 +148,9 @@ module CyberSource
148
148
  # Custom attribute writer method with validation
149
149
  # @param [Object] card_acceptor_id Value to be assigned
150
150
  def card_acceptor_id=(card_acceptor_id)
151
- if card_acceptor_id.nil?
152
- fail ArgumentError, 'card_acceptor_id cannot be nil'
153
- end
151
+ #if card_acceptor_id.nil?
152
+ #fail ArgumentError, 'card_acceptor_id cannot be nil'
153
+ #end
154
154
 
155
155
  @card_acceptor_id = card_acceptor_id
156
156
  end
@@ -170,9 +170,9 @@ module CyberSource
170
170
  # Custom attribute writer method with validation
171
171
  # @param [Object] card_terminal_id Value to be assigned
172
172
  def card_terminal_id=(card_terminal_id)
173
- if card_terminal_id.nil?
174
- fail ArgumentError, 'card_terminal_id cannot be nil'
175
- end
173
+ #if card_terminal_id.nil?
174
+ #fail ArgumentError, 'card_terminal_id cannot be nil'
175
+ #end
176
176
 
177
177
  @card_terminal_id = card_terminal_id
178
178
  end
@@ -187,9 +187,9 @@ module CyberSource
187
187
  # Custom attribute writer method with validation
188
188
  # @param [Object] originator_business_application_id Value to be assigned
189
189
  def originator_business_application_id=(originator_business_application_id)
190
- if originator_business_application_id.nil?
191
- fail ArgumentError, 'originator_business_application_id cannot be nil'
192
- end
190
+ #if originator_business_application_id.nil?
191
+ #fail ArgumentError, 'originator_business_application_id cannot be nil'
192
+ #end
193
193
 
194
194
  @originator_business_application_id = originator_business_application_id
195
195
  end
@@ -24,7 +24,7 @@ module CyberSource
24
24
  # Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed.
25
25
  attr_accessor :state
26
26
 
27
- # The type of Instrument Identifier. Possible Values: - enrollable card
27
+ # The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token
28
28
  attr_accessor :type
29
29
 
30
30
  attr_accessor :token_provisioning_information
@@ -89,7 +89,7 @@ module CyberSource
89
89
  :'object' => :'String',
90
90
  :'state' => :'String',
91
91
  :'type' => :'String',
92
- :'token_provisioning_information' => :'TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation',
92
+ :'token_provisioning_information' => :'Ptsv2paymentsTokenInformationTokenProvisioningInformation',
93
93
  :'card' => :'TmsEmbeddedInstrumentIdentifierCard',
94
94
  :'bank_account' => :'TmsEmbeddedInstrumentIdentifierBankAccount',
95
95
  :'tokenized_card' => :'TmsEmbeddedInstrumentIdentifierTokenizedCard',
@@ -24,7 +24,7 @@ module CyberSource
24
24
  # Issuers state for the card number. Possible Values: - ACTIVE - CLOSED : The account has been closed.
25
25
  attr_accessor :state
26
26
 
27
- # The type of Instrument Identifier. Possible Values: - enrollable card
27
+ # The type of Instrument Identifier. Possible Values: - enrollable card - enrollable token
28
28
  attr_accessor :type
29
29
 
30
30
  attr_accessor :token_provisioning_information
@@ -89,7 +89,7 @@ module CyberSource
89
89
  :'object' => :'String',
90
90
  :'state' => :'String',
91
91
  :'type' => :'String',
92
- :'token_provisioning_information' => :'TmsEmbeddedInstrumentIdentifierTokenProvisioningInformation',
92
+ :'token_provisioning_information' => :'Ptsv2paymentsTokenInformationTokenProvisioningInformation',
93
93
  :'card' => :'TmsEmbeddedInstrumentIdentifierCard',
94
94
  :'bank_account' => :'TmsEmbeddedInstrumentIdentifierBankAccount',
95
95
  :'tokenized_card' => :'TmsEmbeddedInstrumentIdentifierTokenizedCard',
@@ -180,9 +180,9 @@ module CyberSource
180
180
  # Custom attribute writer method with validation
181
181
  # @param [Object] report_definition_name Value to be assigned
182
182
  def report_definition_name=(report_definition_name)
183
- if report_definition_name.nil?
184
- fail ArgumentError, 'report_definition_name cannot be nil'
185
- end
183
+ #if report_definition_name.nil?
184
+ #fail ArgumentError, 'report_definition_name cannot be nil'
185
+ #end
186
186
 
187
187
  #if report_definition_name !~ Regexp.new(/[a-zA-Z]+/)
188
188
  #fail ArgumentError, 'invalid value for "report_definition_name", must conform to the pattern /[a-zA-Z]+/.'
@@ -16,7 +16,7 @@ module CyberSource
16
16
  # Amount that was credited to the cardholder's account. Returned by PIN debit credit.
17
17
  attr_accessor :credit_amount
18
18
 
19
- # 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.
19
+ # 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.
20
20
  attr_accessor :currency
21
21
 
22
22
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions
16
- # Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)
16
+ # Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID)
17
17
  attr_accessor :settlement_method
18
18
 
19
19
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -16,7 +16,7 @@ module CyberSource
16
16
  # Amount you requested for the capture.
17
17
  attr_accessor :total_amount
18
18
 
19
- # 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.
19
+ # 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.
20
20
  attr_accessor :currency
21
21
 
22
22
  # The fee decided by the PSP/Processor per transaction.
@@ -13,10 +13,10 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class PtsV2PaymentsOrderPost201ResponseBuyerInformationPersonalIdentification
16
- # The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
16
+ # The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` - `PASSPORT_NUMBER` - `PERSONAL_ID` - `TAX_ID` This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.
17
17
  attr_accessor :type
18
18
 
19
- # The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the `personal_id` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy.
19
+ # The value of the identification type. This field is supported only on the following processors. #### ComercioLatino Set this field to the Cadastro de Pessoas Fisicas (CPF). #### CyberSource Latin American Processing Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. If `type = PASSPORT`, this is the cardholder's passport number. Recommended for Discover ProtectBuy.
20
20
  attr_accessor :id
21
21
 
22
22
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class PtsV2PaymentsOrderPost201ResponseOrderInformationAmountDetails
16
- # 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.
16
+ # 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.
17
17
  attr_accessor :total_amount
18
18
 
19
19
  # Currency used for the order
@@ -40,7 +40,7 @@ module CyberSource
40
40
  # Payment card billing country. Use the two-character [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). #### SEPA/BACS Required for Create Mandate and Import Mandate #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
41
41
  attr_accessor :country
42
42
 
43
- # Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_email` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
43
+ # Customer's email address, including the full domain name. #### CyberSource through VisaNet Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. #### Chase Paymentech Solutions Optional field. #### Credit Mutuel-CIC Optional field. #### OmniPay Direct Optional field. #### SIX Optional field. #### TSYS Acquiring Solutions Required when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`. #### Worldpay VAP Optional field. #### All other processors Not used.
44
44
  attr_accessor :email
45
45
 
46
46
  # Whether buyer has verified their identity. Used in case of PayPal transactions. Possible Values: * VERIFIED * UNVERIFIED
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class PtsV2PaymentsPost201Response2OrderInformationAmountDetails
16
- # 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.
16
+ # 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.
17
17
  attr_accessor :total_amount
18
18
 
19
19
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -13,13 +13,13 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class PtsV2PaymentsPost201ResponseBuyerInformation
16
- # Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the `customer_account_id` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
16
+ # Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. #### Comercio Latino For recurring payments in Mexico, the value is the customer's contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. #### Worldpay VAP For a follow-on credit with Worldpay VAP, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used.
17
17
  attr_accessor :merchant_customer_id
18
18
 
19
- # Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
19
+ # Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor.
20
20
  attr_accessor :date_of_birth
21
21
 
22
- # Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)
22
+ # Customer's government-assigned tax identification number. #### Tax Calculation Optional for international and value added taxes only. Not applicable to U.S. and Canadian taxes.
23
23
  attr_accessor :vat_registration_number
24
24
 
25
25
  attr_accessor :personal_identification
@@ -25,7 +25,7 @@ module CyberSource
25
25
  # URL for the card-issuing bank's authentication form that you receive when the card is enrolled. The value can be very large.
26
26
  attr_accessor :acs_url
27
27
 
28
- # Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_. For details about possible values, see `pa_enroll_authentication_path` field description and \"Rules-Based Payer Authentication\" in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)
28
+ # Indicates what displays to the customer during the authentication process. This field can contain one of these values: - `ADS`: (Card not enrolled) customer prompted to activate the card during the checkout process. - `ATTEMPTS`: (Attempts processing) Processing briefly displays before the checkout process is completed. - `ENROLLED`: (Card enrolled) the card issuer's authentication window displays. - `UNKNOWN`: Card enrollment status cannot be determined. - `NOREDIRECT`: (Card not enrolled, authentication unavailable, or error occurred) nothing displays to the customer. The following values can be returned if you are using rules-based payer authentication. - `RIBA`: The card-issuing bank supports risk-based authentication, but whether the cardholder is likely to be challenged cannot be determined. - `RIBA_PASS`: The card-issuing bank supports risk-based authentication and it is likely that the cardholder will not be challenged to provide credentials, also known as _silent authentication_.
29
29
  attr_accessor :authentication_path
30
30
 
31
31
  # The Base64 encoded JSON Payload of CB specific Authorization Values returned in the challenge Flow
@@ -83,7 +83,7 @@ module CyberSource
83
83
  # Raw result of the authentication check. If you are configured for Asia, Middle East, and Africa Gateway Processing, you need to send the value of this field in your authorization request. This field can contain one of these values: - `A`: Proof of authentication attempt was generated. - `N`: Customer failed or canceled authentication. Transaction denied. - `U`: Authentication not completed regardless of the reason. - `Y`: Customer was successfully authenticated.
84
84
  attr_accessor :pares_status
85
85
 
86
- # Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For details about possible values, see the `pa_enroll_proofxml` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/) - For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes. - For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback.
86
+ # Date and time of the enrollment check combined with the VEReq and VERes elements. If you ever need to show proof of enrollment checking, you may need to parse the string for the information required by the payment card company. The value can be very large. For cards issued in the U.S. or Canada, Visa may require this data for specific merchant category codes.For cards not issued in the U.S. or Canada, your bank may require this data as proof of enrollment checking for any payer authentication transaction that you re-present because of a chargeback.
87
87
  attr_accessor :proof_xml
88
88
 
89
89
  # Encrypted version of the card number used in the payer authentication request message.
@@ -110,7 +110,7 @@ module CyberSource
110
110
  # For enroll, Returned only for Mastercard transactions. Indicates that authentication is not required because the customer is not enrolled. Add the value of this field to the authorization field ucaf_collection_indicator. This field can contain these values: 0, 1. For validate, Numeric electronic commerce indicator (ECI) returned only for Mastercard Identity Check transactions. The field is absent when authentication fails. You must send this value to your payment processor in the request for card authorization. This field contain one of these values: - `0`: Authentication data not collected, and customer authentication was not completed. - `1`: Authentication data not collected because customer authentication was not completed. - `2`: Authentication data collected because customer completed authentication.
111
111
  attr_accessor :ucaf_collection_indicator
112
112
 
113
- # Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed. For details, see `pa_enroll_veres_enrolled` field description in [CyberSource Payer Authentication Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/)
113
+ # Result of the enrollment check. This field can contain one of these values: - `Y`: Card enrolled or can be enrolled; you must authenticate. Liability shift. - `N`: Card not enrolled; proceed with authorization. Liability shift. - `U`: Unable to authenticate regardless of the reason. No liability shift. **Note** This field only applies to the Asia, Middle East, and Africa Gateway. If you are configured for this processor, you must send the value of this field in your authorization request. The following value can be returned if you are using rules-based Payer Authentication: - `B`: Indicates that authentication was bypassed.
114
114
  attr_accessor :veres_enrolled
115
115
 
116
116
  # This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS
@@ -16,10 +16,10 @@ module CyberSource
16
16
  # Amount you requested for the payment or capture. This value is returned for partial authorizations. This field is also returned on incremental authorizations will contain the aggregated amount from the original authorizations and all the incremental authorizations.
17
17
  attr_accessor :total_amount
18
18
 
19
- # Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase. #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in Merchant Descriptors Using the SCMP API.
19
+ # Amount that was authorized. Returned by authorization service. #### PIN debit Amount of the purchase. Returned by PIN debit purchase.
20
20
  attr_accessor :authorized_amount
21
21
 
22
- # 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.
22
+ # 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.
23
23
  attr_accessor :currency
24
24
 
25
25
  # 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.
@@ -29,19 +29,19 @@ module CyberSource
29
29
 
30
30
  attr_accessor :shipping_address
31
31
 
32
- # Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present. For all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
32
+ # Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron **Note** Additional values may be present.
33
33
  attr_accessor :scheme
34
34
 
35
- # Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field. For all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
35
+ # Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field or from the first six characters of the `customer_cc_num` field.
36
36
  attr_accessor :bin
37
37
 
38
- # Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. For all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
38
+ # Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type.
39
39
  attr_accessor :account_type
40
40
 
41
- # Name of the bank or entity that issued the card account. For all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
41
+ # Name of the bank or entity that issued the card account.
42
42
  attr_accessor :issuer
43
43
 
44
- # Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center. For all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).
44
+ # Country (two-digit country code) associated with the BIN of the customer's card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the CyberSource Business Center.
45
45
  attr_accessor :bin_country
46
46
 
47
47
  attr_accessor :e_wallet
@@ -15,7 +15,7 @@ module CyberSource
15
15
  class PtsV2PaymentsPost201ResponsePaymentInformationBank
16
16
  attr_accessor :account
17
17
 
18
- # Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_routing_number` or `ecp_credit_corrected_routing_number` reply field descriptions in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)
18
+ # Corrected account number from the ACH verification service.
19
19
  attr_accessor :corrected_routing_number
20
20
 
21
21
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class PtsV2PaymentsPost201ResponsePaymentInformationBankAccount
16
- # Corrected account number from the ACH verification service. For details, see `ecp_debit_corrected_account_number` or `ecp_credit_corrected_account_number` field descriptions in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)
16
+ # Corrected account number from the ACH verification service.
17
17
  attr_accessor :corrected_account_number
18
18
 
19
19
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -13,10 +13,10 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions
16
- # Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID) For details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)
16
+ # Method used for settlement. Possible values: - `A`: Automated Clearing House (default for credits and for transactions using Canadian dollars) - `F`: Facsimile draft (U.S. dollars only) - `B`: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID)
17
17
  attr_accessor :settlement_method
18
18
 
19
- # Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification For a description of this feature and a list of supported processors, see \"Verification and Validation\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).
19
+ # Level of fraud screening. Possible values: - `1`: Validation — default if the field has not already been configured for your merchant ID - `2`: Verification
20
20
  attr_accessor :fraud_screening_level
21
21
 
22
22
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -13,10 +13,10 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class PtsV2PaymentsPost201ResponseProcessorInformationAchVerification
16
- # Results from the ACH verification service. For details about this service and the possible values for the results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).
16
+ # Results from the ACH verification service.
17
17
  attr_accessor :result_code
18
18
 
19
- # Raw results from the ACH verification service. For details about this service and the possible values for the raw results, see \"ACH Verification\" and \"Verification Codes\" in the [Electronic Check Services Using the SCMP API](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/).
19
+ # Raw results from the ACH verification service.
20
20
  attr_accessor :result_code_raw
21
21
 
22
22
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -13,7 +13,7 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class PtsV2PaymentsPost201ResponseProcessorInformationCardVerification
16
- # CVN result code. For details, see the `auth_cv_result` reply 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/)
16
+ # CVN result code.
17
17
  attr_accessor :result_code
18
18
 
19
19
  # CVN result code sent directly from the processor. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of card verification. Use for debugging purposes only.
@@ -13,31 +13,31 @@ require 'date'
13
13
 
14
14
  module CyberSource
15
15
  class PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults
16
- # Mapped Electronic Verification response code for the customer's name. For details, see `auth_ev_name` 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/)
16
+ # Mapped Electronic Verification response code for the customer's name.
17
17
  attr_accessor :code
18
18
 
19
19
  # Raw Electronic Verification response code from the processor for the customer's last name
20
20
  attr_accessor :code_raw
21
21
 
22
- # Mapped Electronic Verification response code for the customer's email address. For details, see `auth_ev_email` 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/)
22
+ # Mapped Electronic Verification response code for the customer's email address.
23
23
  attr_accessor :email
24
24
 
25
25
  # Raw Electronic Verification response code from the processor for the customer's email address.
26
26
  attr_accessor :email_raw
27
27
 
28
- # Mapped Electronic Verification response code for the customer's phone number. For details, see `auth_ev_phone_number` 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/)
28
+ # Mapped Electronic Verification response code for the customer's phone number.
29
29
  attr_accessor :phone_number
30
30
 
31
31
  # Raw Electronic Verification response code from the processor for the customer's phone number.
32
32
  attr_accessor :phone_number_raw
33
33
 
34
- # Mapped Electronic Verification response code for the customer's postal code. For details, see `auth_ev_postal_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)
34
+ # Mapped Electronic Verification response code for the customer's postal code.
35
35
  attr_accessor :postal_code
36
36
 
37
37
  # Raw Electronic Verification response code from the processor for the customer's postal code.
38
38
  attr_accessor :postal_code_raw
39
39
 
40
- # Mapped Electronic Verification response code for the customer's street address. For details, see `auth_ev_street` 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/)
40
+ # Mapped Electronic Verification response code for the customer's street address.
41
41
  attr_accessor :street
42
42
 
43
43
  # Raw Electronic Verification response code from the processor for the customer's street address.