cybersource_rest_client 0.0.73 → 0.0.75

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 (148) hide show
  1. checksums.yaml +4 -4
  2. data/lib/AuthenticationSDK/core/MerchantConfig.rb +2 -1
  3. data/lib/cybersource_rest_client/api/batches_api.rb +9 -9
  4. data/lib/cybersource_rest_client/api/bin_lookup_api.rb +5 -5
  5. data/lib/cybersource_rest_client/api/create_new_webhooks_api.rb +6 -6
  6. data/lib/cybersource_rest_client/api/decision_manager_api.rb +3 -3
  7. data/lib/cybersource_rest_client/api/device_de_association_api.rb +168 -0
  8. data/lib/cybersource_rest_client/api/device_search_api.rb +78 -5
  9. data/lib/cybersource_rest_client/api/manage_webhooks_api.rb +9 -9
  10. data/lib/cybersource_rest_client/api/merchant_boarding_api.rb +3 -3
  11. data/lib/cybersource_rest_client/api/payment_tokens_api.rb +96 -0
  12. data/lib/cybersource_rest_client/api/subscriptions_api.rb +5 -2
  13. data/lib/cybersource_rest_client/models/create_order_request.rb +269 -229
  14. data/lib/cybersource_rest_client/models/de_association_request_body.rb +190 -0
  15. data/lib/cybersource_rest_client/models/generate_capture_context_request.rb +1 -1
  16. data/lib/cybersource_rest_client/models/generate_unified_checkout_capture_context_request.rb +2 -2
  17. data/lib/cybersource_rest_client/models/get_subscription_response.rb +15 -5
  18. data/lib/cybersource_rest_client/models/get_subscription_response_reactivation_information.rb +213 -0
  19. data/lib/cybersource_rest_client/models/inline_response_200_10.rb +292 -0
  20. data/lib/cybersource_rest_client/models/{inline_response_200_9_records.rb → inline_response_200_10_records.rb} +3 -3
  21. data/lib/cybersource_rest_client/models/{inline_response_200_9_response_record.rb → inline_response_200_10_response_record.rb} +2 -2
  22. data/lib/cybersource_rest_client/models/{inline_response_200_9_response_record_additional_updates.rb → inline_response_200_10_response_record_additional_updates.rb} +1 -1
  23. data/lib/cybersource_rest_client/models/{inline_response_200_9_source_record.rb → inline_response_200_10_source_record.rb} +1 -1
  24. data/lib/cybersource_rest_client/models/inline_response_200_2.rb +253 -253
  25. data/lib/cybersource_rest_client/models/inline_response_200_5.rb +55 -10
  26. data/lib/cybersource_rest_client/models/inline_response_200_5_devices.rb +357 -0
  27. data/lib/cybersource_rest_client/models/inline_response_200_6.rb +10 -55
  28. data/lib/cybersource_rest_client/models/inline_response_200_7.rb +33 -37
  29. data/lib/cybersource_rest_client/models/{inline_response_200_6_devices.rb → inline_response_200_7_devices.rb} +2 -2
  30. data/lib/cybersource_rest_client/models/{inline_response_200_6_payment_processor_to_terminal_map.rb → inline_response_200_7_payment_processor_to_terminal_map.rb} +1 -1
  31. data/lib/cybersource_rest_client/models/inline_response_200_8.rb +47 -86
  32. data/lib/cybersource_rest_client/models/{inline_response_200_7__embedded.rb → inline_response_200_8__embedded.rb} +2 -2
  33. data/lib/cybersource_rest_client/models/{inline_response_200_7__embedded__links.rb → inline_response_200_8__embedded__links.rb} +2 -2
  34. data/lib/cybersource_rest_client/models/{inline_response_200_7__embedded__links_reports.rb → inline_response_200_8__embedded__links_reports.rb} +1 -1
  35. data/lib/cybersource_rest_client/models/{inline_response_200_7__embedded_batches.rb → inline_response_200_8__embedded_batches.rb} +3 -3
  36. data/lib/cybersource_rest_client/models/{inline_response_200_7__embedded_totals.rb → inline_response_200_8__embedded_totals.rb} +1 -1
  37. data/lib/cybersource_rest_client/models/inline_response_200_8__links.rb +16 -17
  38. data/lib/cybersource_rest_client/models/inline_response_200_9.rb +47 -49
  39. data/lib/cybersource_rest_client/models/inline_response_200_9__links.rb +201 -0
  40. data/lib/cybersource_rest_client/models/{inline_response_200_8__links_report.rb → inline_response_200_9__links_report.rb} +1 -1
  41. data/lib/cybersource_rest_client/models/{inline_response_200_8_billing.rb → inline_response_200_9_billing.rb} +1 -1
  42. data/lib/cybersource_rest_client/models/inline_response_201.rb +227 -218
  43. data/lib/cybersource_rest_client/models/inline_response_201_1.rb +218 -248
  44. data/lib/cybersource_rest_client/models/inline_response_201_2.rb +248 -281
  45. data/lib/cybersource_rest_client/models/{inline_response_201_1_payout_information.rb → inline_response_201_2_payout_information.rb} +216 -216
  46. data/lib/cybersource_rest_client/models/{inline_response_201_1_payout_information_pull_funds.rb → inline_response_201_2_payout_information_pull_funds.rb} +213 -213
  47. data/lib/cybersource_rest_client/models/{inline_response_201_1_payout_information_push_funds.rb → inline_response_201_2_payout_information_push_funds.rb} +417 -417
  48. data/lib/cybersource_rest_client/models/inline_response_201_3.rb +281 -222
  49. data/lib/cybersource_rest_client/models/{inline_response_201_2_integration_information.rb → inline_response_201_3_integration_information.rb} +192 -192
  50. data/lib/cybersource_rest_client/models/{inline_response_201_2_integration_information_tenant_configurations.rb → inline_response_201_3_integration_information_tenant_configurations.rb} +253 -253
  51. data/lib/cybersource_rest_client/models/{inline_response_201_2_organization_information.rb → inline_response_201_3_organization_information.rb} +217 -217
  52. data/lib/cybersource_rest_client/models/{inline_response_201_2_product_information_setups.rb → inline_response_201_3_product_information_setups.rb} +214 -214
  53. data/lib/cybersource_rest_client/models/{inline_response_201_2_registration_information.rb → inline_response_201_3_registration_information.rb} +222 -222
  54. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups.rb → inline_response_201_3_setups.rb} +219 -219
  55. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups_commerce_solutions.rb → inline_response_201_3_setups_commerce_solutions.rb} +209 -209
  56. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups_payments.rb → inline_response_201_3_setups_payments.rb} +369 -369
  57. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups_payments_alternative_payment_methods.rb → inline_response_201_3_setups_payments_alternative_payment_methods.rb} +221 -221
  58. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups_payments_alternative_payment_methods_configuration_status.rb → inline_response_201_3_setups_payments_alternative_payment_methods_configuration_status.rb} +200 -200
  59. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups_payments_card_processing.rb → inline_response_201_3_setups_payments_card_processing.rb} +199 -199
  60. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups_payments_card_processing_configuration_status.rb → inline_response_201_3_setups_payments_card_processing_configuration_status.rb} +255 -255
  61. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups_payments_card_processing_subscription_status.rb → inline_response_201_3_setups_payments_card_processing_subscription_status.rb} +234 -234
  62. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups_payments_digital_payments.rb → inline_response_201_3_setups_payments_digital_payments.rb} +189 -189
  63. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups_risk.rb → inline_response_201_3_setups_risk.rb} +199 -199
  64. data/lib/cybersource_rest_client/models/{inline_response_201_2_setups_value_added_services.rb → inline_response_201_3_setups_value_added_services.rb} +209 -209
  65. data/lib/cybersource_rest_client/models/inline_response_201_4.rb +222 -312
  66. data/lib/cybersource_rest_client/models/{inline_response_201_3_key_information.rb → inline_response_201_4_key_information.rb} +300 -300
  67. data/lib/cybersource_rest_client/models/{inline_response_201_3_key_information_error_information.rb → inline_response_201_4_key_information_error_information.rb} +202 -202
  68. data/lib/cybersource_rest_client/models/{inline_response_201_3_key_information_error_information_details.rb → inline_response_201_4_key_information_error_information_details.rb} +201 -201
  69. data/lib/cybersource_rest_client/models/inline_response_201_5.rb +312 -277
  70. data/lib/cybersource_rest_client/models/inline_response_201_6.rb +277 -202
  71. data/lib/cybersource_rest_client/models/{inline_response_201_5_payloads.rb → inline_response_201_6_payloads.rb} +189 -189
  72. data/lib/cybersource_rest_client/models/{inline_response_201_5_payloads_test_payload.rb → inline_response_201_6_payloads_test_payload.rb} +190 -190
  73. data/lib/cybersource_rest_client/models/inline_response_201_7.rb +202 -0
  74. data/lib/cybersource_rest_client/models/inline_response_201_order_information.rb +189 -0
  75. data/lib/cybersource_rest_client/models/inline_response_201_order_information_ship_to.rb +315 -0
  76. data/lib/cybersource_rest_client/models/inline_response_201_payment_information.rb +199 -0
  77. data/lib/cybersource_rest_client/models/inline_response_201_payment_information_e_wallet.rb +196 -0
  78. data/lib/cybersource_rest_client/models/inline_response_201_payment_information_tokenized_payment_method.rb +213 -0
  79. data/lib/cybersource_rest_client/models/payments_products.rb +1 -1
  80. data/lib/cybersource_rest_client/models/payments_products_unified_checkout.rb +199 -0
  81. data/lib/cybersource_rest_client/models/payments_products_unified_checkout_configuration_information.rb +189 -0
  82. data/lib/cybersource_rest_client/models/payments_products_unified_checkout_configuration_information_configurations.rb +189 -0
  83. data/lib/cybersource_rest_client/models/payments_products_unified_checkout_configuration_information_configurations_features.rb +189 -0
  84. data/lib/cybersource_rest_client/models/payments_products_unified_checkout_configuration_information_configurations_features_paze.rb +213 -0
  85. data/lib/cybersource_rest_client/models/payments_products_unified_checkout_subscription_information.rb +225 -0
  86. data/lib/cybersource_rest_client/models/payments_products_unified_checkout_subscription_information_features.rb +189 -0
  87. data/lib/cybersource_rest_client/models/payments_products_unified_checkout_subscription_information_features_paze_for_unified_checkout.rb +190 -0
  88. data/lib/cybersource_rest_client/models/post_device_search_request.rb +223 -0
  89. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_installment_information.rb +609 -609
  90. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_account_information_card.rb +269 -269
  91. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information.rb +364 -354
  92. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_card.rb +309 -309
  93. data/lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_tokenized_payment_method.rb +213 -0
  94. data/lib/cybersource_rest_client/models/pts_v2_retrieve_payment_token_get400_response.rb +252 -0
  95. data/lib/cybersource_rest_client/models/pts_v2_retrieve_payment_token_get502_response.rb +240 -0
  96. data/lib/cybersource_rest_client/models/ptsv2billingagreements_payment_information_card.rb +258 -258
  97. data/lib/cybersource_rest_client/models/ptsv2billingagreements_payment_information_tokenized_card.rb +275 -275
  98. data/lib/cybersource_rest_client/models/ptsv2intents_event_information.rb +212 -0
  99. data/lib/cybersource_rest_client/models/ptsv2intents_order_information_ship_to.rb +354 -332
  100. data/lib/cybersource_rest_client/models/ptsv2intents_payment_information.rb +220 -189
  101. data/lib/cybersource_rest_client/models/ptsv2intents_payment_information_e_wallet.rb +196 -0
  102. data/lib/cybersource_rest_client/models/ptsv2intents_payment_information_tokenized_payment_method.rb +241 -0
  103. data/lib/cybersource_rest_client/models/ptsv2intents_processing_information.rb +351 -219
  104. data/lib/cybersource_rest_client/models/ptsv2intents_recipient_information.rb +245 -0
  105. data/lib/cybersource_rest_client/models/ptsv2intents_sender_information.rb +277 -0
  106. data/lib/cybersource_rest_client/models/ptsv2intents_sender_information_account.rb +190 -0
  107. data/lib/cybersource_rest_client/models/ptsv2intents_travel_information.rb +211 -0
  108. data/lib/cybersource_rest_client/models/ptsv2intents_travel_information_agency.rb +245 -0
  109. data/lib/cybersource_rest_client/models/{inline_response_200_7__links.rb → ptsv2intentsid_payment_information.rb} +189 -200
  110. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_order_information_amount_details.rb +417 -400
  111. data/lib/cybersource_rest_client/models/ptsv2paymentreferences_payment_information_card.rb +275 -275
  112. data/lib/cybersource_rest_client/models/ptsv2payments_installment_information.rb +433 -416
  113. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb +668 -651
  114. data/lib/cybersource_rest_client/models/ptsv2payments_order_information_line_items.rb +716 -699
  115. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information.rb +356 -346
  116. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb +445 -445
  117. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb +377 -377
  118. data/lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_payment_method.rb +196 -0
  119. data/lib/cybersource_rest_client/models/ptsv2paymentsidcaptures_installment_information.rb +604 -604
  120. data/lib/cybersource_rest_client/models/ptsv2paymentsidrefunds_payment_information_card.rb +377 -377
  121. data/lib/cybersource_rest_client/models/ptsv2paymenttokens_payment_information.rb +199 -0
  122. data/lib/cybersource_rest_client/models/ptsv2paymenttokens_processing_information.rb +192 -0
  123. data/lib/cybersource_rest_client/models/ptsv2payouts_payment_information_card.rb +258 -258
  124. data/lib/cybersource_rest_client/models/request.rb +199 -0
  125. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information_card.rb +241 -241
  126. data/lib/cybersource_rest_client/models/riskv1authenticationresults_payment_information_tokenized_card.rb +258 -258
  127. data/lib/cybersource_rest_client/models/riskv1authentications_payment_information_tokenized_card.rb +351 -351
  128. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_card.rb +268 -268
  129. data/lib/cybersource_rest_client/models/riskv1authenticationsetups_payment_information_tokenized_card.rb +299 -299
  130. data/lib/cybersource_rest_client/models/riskv1decisions_payment_information_card.rb +259 -259
  131. data/lib/cybersource_rest_client/models/riskv1decisions_payment_information_tokenized_card.rb +259 -259
  132. data/lib/cybersource_rest_client/models/riskv1decisions_travel_information_legs.rb +16 -5
  133. data/lib/cybersource_rest_client/models/riskv1liststypeentries_payment_information_card.rb +224 -224
  134. data/lib/cybersource_rest_client/models/tms_bin_lookup_issuer_information.rb +264 -264
  135. data/lib/cybersource_rest_client/models/tms_bin_lookup_payment_account_information_card.rb +277 -277
  136. data/lib/cybersource_rest_client/models/tms_bin_lookup_payment_account_information_card_brands.rb +213 -213
  137. data/lib/cybersource_rest_client/models/tms_bin_lookup_payment_account_information_features.rb +430 -430
  138. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_brands.rb +201 -201
  139. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb +365 -365
  140. data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb +12 -1
  141. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_payment_information_card.rb +218 -218
  142. data/lib/cybersource_rest_client/models/tss_v2_transactions_post201_response__embedded_processor_information.rb +245 -234
  143. data/lib/cybersource_rest_client/models/update_order_request.rb +229 -229
  144. data/lib/cybersource_rest_client/models/upv1capturecontexts_capture_mandate.rb +12 -1
  145. data/lib/cybersource_rest_client/models/upv1capturecontexts_complete_mandate.rb +18 -7
  146. data/lib/cybersource_rest_client.rb +75 -39
  147. metadata +77 -41
  148. data/lib/cybersource_rest_client/api/device_de_association_v3_api.rb +0 -96
@@ -1,445 +1,445 @@
1
- =begin
2
- #CyberSource Merged Spec
3
-
4
- #All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
5
-
6
- OpenAPI spec version: 0.0.1
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 2.4.38
10
- =end
11
-
12
- require 'date'
13
-
14
- module CyberSource
15
- class Ptsv2paymentsPaymentInformationCard
16
- # The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
17
- attr_accessor :number
18
-
19
- # Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response.
20
- attr_accessor :expiration_month
21
-
22
- # Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response.
23
- attr_accessor :expiration_year
24
-
25
- # Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `014`: Enroute[^1] - `021`: JAL[^1] - `024`: Maestro (UK Domestic)[^1] - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `039`: Encoded account number[^1] - `040`: UATP[^1] - `042`: Maestro (International)[^1] - `050`: Hipercard[^2,3] - `051`: Aura - `054`: Elo[^3] - `062`: China UnionPay - '070': EFTPOS [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International
26
- attr_accessor :type
27
-
28
- # Flag that specifies the type of account associated with the card. This field is available only for China UnionPay, Cielo, Comercio Latino and Visa Platform Connect. The cardholder provides this information during the payment process. This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **China UnionPayCard Transactions on China UnionPay:** Possible values: - C: Domestic credit card - D: Domestic debit card - F: International credit card - I: International debit card When the value is D, the e-commerce indicator and CAVV fields must be included in the authorization request. When the value is C, F or I the card verification number, expiration month and expiration year fields must in included in the authorization request. **Cielo and Comercio Latino Credit Card Transactions:** On these processors, this field is supported only for authorizations. Possible values: - CR: Credit card - DB: Debit card **Visa Platform Connect Credit Card Transactions:** This field is supported for all card types on Visa Platform Connect. For combo **card present** transactions with Mastercard on Brazilian-issued cards, possible values: - CR: Credit card - DB: Debit Card For combo **card not present** transactions with Mastercard on Brazilian-issued cards, possible values: - C: Credit card - D: Debit card A value of CR or DB in the useAs field takes precedence over any value in the Source Account Type field.
29
- attr_accessor :use_as
30
-
31
- # Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for CyberSource through VisaNet (CtV). **Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - `CH`: Checking account - `CR`: Credit card account - `SA`: Saving account - `LI`: Line of credit or credit portion of combo card - `PP`: Prepaid card account or prepaid portion of combo card - `UA`: Universal account If useAs is set to credit/debit and there is a value in SourceAccountType, the value in the SourceAccountType field will take precedence. If useAs is set to CR/DB and there is a value in SourceAccountType, the value in the useAs field will take precedence.
32
- attr_accessor :source_account_type
33
-
34
- # Type of account that is being used when the value for the override_payment_method field is line of credit (LI) or prepaid card (PP). Possible values for line of credit: - `AGRC`: Visa Agro Custeio - `AGRE`: Visa Agro Electron - `AGRI`: Visa Agro Investimento - `AGRO`: Visa Agro Possible values for prepaid card: - `VVA`: Visa Vale Alimentacao - `VVF`: Visa Vale Flex - `VVR`: Visa Vale Refeicao This field is supported only for combo card transactions in Brazil on CyberSource through VisaNet.
35
- attr_accessor :source_account_type_details
36
-
37
- # Card Verification Number. #### FDMS Nashville Required for American Express or if swiped; otherwise, optional. #### Ingenico ePayments Do not include this field when `commerceIndicator=recurring`. **Note** Ingenico ePayments was previously called _Global Collect_. #### TSYS Acquiring Solutions Optional if pointOfSaleInformation.entryMode=keyed; otherwise, not used. #### GPX Optional. #### All other processors: Optional.
38
- attr_accessor :security_code
39
-
40
- # Indicates whether a CVN code was sent. Possible values: - `0` (default): CVN service not requested. This default value is used when you do not include `securityCode` field in the request. - `1` (default): CVN service requested and supported. This default value is used when you include `securityCode` field in the request. - `2`: CVN on credit card is illegible. - `9`: CVN was not imprinted on credit card. #### FDMS Nashville Required for American Express cards; otherwise, optional. #### TSYS Acquiring Solutions Optional if `pointOfSaleInformation.entryMode=keyed`; otherwise, not used. #### All other processors Optional.
41
- attr_accessor :security_code_indicator
42
-
43
- # Identifier for the issuing bank that provided the customer's encoded account number. Contact your processor for the bank's ID.
44
- attr_accessor :account_encoder_id
45
-
46
- # Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions.
47
- attr_accessor :issue_number
48
-
49
- # Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions.
50
- attr_accessor :start_month
51
-
52
- # Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions.
53
- attr_accessor :start_year
54
-
55
- # Name of the card product. Possible value: - BNDES This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 115-120 - Field: Brazil Country Data
56
- attr_accessor :product_name
57
-
58
- # This field would contain the indicator for transaction type Possible values: - AC: Agriculture Maintenance Account - AE: Agriculture Debit Account/Electron - AG: Agriculture - AI: Agriculture Investment Loan - CG: Brazil Cargo - CS: Construction - DS: Distribution - HC: Healthcare - LP: Visa Large Purchase Advantage - MA: Visa Mobile Agent - MB: Interoperable Mobile Branchless Banking - MG: Visa Mobile General - VA: Visa Vale - Supermarket - VF: Visa Vale - Fuel - VR: Visa Vale - Restaurant
59
- attr_accessor :product_subtype
60
-
61
- # Flag that identifies how the card type was selected. Possible values: - 0: Card type was selected based on default acquirer settings. - 1: Customer selected the card type.
62
- attr_accessor :type_selection_indicator
63
-
64
- # Attribute mapping from ruby-style variable name to JSON key.
65
- def self.attribute_map
66
- {
67
- :'number' => :'number',
68
- :'expiration_month' => :'expirationMonth',
69
- :'expiration_year' => :'expirationYear',
70
- :'type' => :'type',
71
- :'use_as' => :'useAs',
72
- :'source_account_type' => :'sourceAccountType',
73
- :'source_account_type_details' => :'sourceAccountTypeDetails',
74
- :'security_code' => :'securityCode',
75
- :'security_code_indicator' => :'securityCodeIndicator',
76
- :'account_encoder_id' => :'accountEncoderId',
77
- :'issue_number' => :'issueNumber',
78
- :'start_month' => :'startMonth',
79
- :'start_year' => :'startYear',
80
- :'product_name' => :'productName',
81
- :'product_subtype' => :'productSubtype',
82
- :'type_selection_indicator' => :'typeSelectionIndicator'
83
- }
84
- end
85
-
86
- # Attribute mapping from JSON key to ruby-style variable name.
87
- def self.json_map
88
- {
89
- :'number' => :'number',
90
- :'expiration_month' => :'expiration_month',
91
- :'expiration_year' => :'expiration_year',
92
- :'type' => :'type',
93
- :'use_as' => :'use_as',
94
- :'source_account_type' => :'source_account_type',
95
- :'source_account_type_details' => :'source_account_type_details',
96
- :'security_code' => :'security_code',
97
- :'security_code_indicator' => :'security_code_indicator',
98
- :'account_encoder_id' => :'account_encoder_id',
99
- :'issue_number' => :'issue_number',
100
- :'start_month' => :'start_month',
101
- :'start_year' => :'start_year',
102
- :'product_name' => :'product_name',
103
- :'product_subtype' => :'product_subtype',
104
- :'type_selection_indicator' => :'type_selection_indicator'
105
- }
106
- end
107
-
108
- # Attribute type mapping.
109
- def self.swagger_types
110
- {
111
- :'number' => :'String',
112
- :'expiration_month' => :'String',
113
- :'expiration_year' => :'String',
114
- :'type' => :'String',
115
- :'use_as' => :'String',
116
- :'source_account_type' => :'String',
117
- :'source_account_type_details' => :'String',
118
- :'security_code' => :'String',
119
- :'security_code_indicator' => :'String',
120
- :'account_encoder_id' => :'String',
121
- :'issue_number' => :'String',
122
- :'start_month' => :'String',
123
- :'start_year' => :'String',
124
- :'product_name' => :'String',
125
- :'product_subtype' => :'String',
126
- :'type_selection_indicator' => :'String'
127
- }
128
- end
129
-
130
- # Initializes the object
131
- # @param [Hash] attributes Model attributes in the form of hash
132
- def initialize(attributes = {})
133
- return unless attributes.is_a?(Hash)
134
-
135
- # convert string to symbol for hash key
136
- attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
137
-
138
- if attributes.has_key?(:'number')
139
- self.number = attributes[:'number']
140
- end
141
-
142
- if attributes.has_key?(:'expirationMonth')
143
- self.expiration_month = attributes[:'expirationMonth']
144
- end
145
-
146
- if attributes.has_key?(:'expirationYear')
147
- self.expiration_year = attributes[:'expirationYear']
148
- end
149
-
150
- if attributes.has_key?(:'type')
151
- self.type = attributes[:'type']
152
- end
153
-
154
- if attributes.has_key?(:'useAs')
155
- self.use_as = attributes[:'useAs']
156
- end
157
-
158
- if attributes.has_key?(:'sourceAccountType')
159
- self.source_account_type = attributes[:'sourceAccountType']
160
- end
161
-
162
- if attributes.has_key?(:'sourceAccountTypeDetails')
163
- self.source_account_type_details = attributes[:'sourceAccountTypeDetails']
164
- end
165
-
166
- if attributes.has_key?(:'securityCode')
167
- self.security_code = attributes[:'securityCode']
168
- end
169
-
170
- if attributes.has_key?(:'securityCodeIndicator')
171
- self.security_code_indicator = attributes[:'securityCodeIndicator']
172
- end
173
-
174
- if attributes.has_key?(:'accountEncoderId')
175
- self.account_encoder_id = attributes[:'accountEncoderId']
176
- end
177
-
178
- if attributes.has_key?(:'issueNumber')
179
- self.issue_number = attributes[:'issueNumber']
180
- end
181
-
182
- if attributes.has_key?(:'startMonth')
183
- self.start_month = attributes[:'startMonth']
184
- end
185
-
186
- if attributes.has_key?(:'startYear')
187
- self.start_year = attributes[:'startYear']
188
- end
189
-
190
- if attributes.has_key?(:'productName')
191
- self.product_name = attributes[:'productName']
192
- end
193
-
194
- if attributes.has_key?(:'productSubtype')
195
- self.product_subtype = attributes[:'productSubtype']
196
- end
197
-
198
- if attributes.has_key?(:'typeSelectionIndicator')
199
- self.type_selection_indicator = attributes[:'typeSelectionIndicator']
200
- end
201
- end
202
-
203
- # Show invalid properties with the reasons. Usually used together with valid?
204
- # @return Array for valid properties with the reasons
205
- def list_invalid_properties
206
- invalid_properties = Array.new
207
- invalid_properties
208
- end
209
-
210
- # Check to see if the all the properties in the model are valid
211
- # @return true if the model is valid
212
- def valid?
213
- true
214
- end
215
-
216
- # Custom attribute writer method with validation
217
- # @param [Object] number Value to be assigned
218
- def number=(number)
219
- @number = number
220
- end
221
-
222
- # Custom attribute writer method with validation
223
- # @param [Object] expiration_month Value to be assigned
224
- def expiration_month=(expiration_month)
225
- @expiration_month = expiration_month
226
- end
227
-
228
- # Custom attribute writer method with validation
229
- # @param [Object] expiration_year Value to be assigned
230
- def expiration_year=(expiration_year)
231
- @expiration_year = expiration_year
232
- end
233
-
234
- # Custom attribute writer method with validation
235
- # @param [Object] use_as Value to be assigned
236
- def use_as=(use_as)
237
- @use_as = use_as
238
- end
239
-
240
- # Custom attribute writer method with validation
241
- # @param [Object] source_account_type Value to be assigned
242
- def source_account_type=(source_account_type)
243
- @source_account_type = source_account_type
244
- end
245
-
246
- # Custom attribute writer method with validation
247
- # @param [Object] source_account_type_details Value to be assigned
248
- def source_account_type_details=(source_account_type_details)
249
- @source_account_type_details = source_account_type_details
250
- end
251
-
252
- # Custom attribute writer method with validation
253
- # @param [Object] security_code Value to be assigned
254
- def security_code=(security_code)
255
- @security_code = security_code
256
- end
257
-
258
- # Custom attribute writer method with validation
259
- # @param [Object] security_code_indicator Value to be assigned
260
- def security_code_indicator=(security_code_indicator)
261
- @security_code_indicator = security_code_indicator
262
- end
263
-
264
- # Custom attribute writer method with validation
265
- # @param [Object] account_encoder_id Value to be assigned
266
- def account_encoder_id=(account_encoder_id)
267
- @account_encoder_id = account_encoder_id
268
- end
269
-
270
- # Custom attribute writer method with validation
271
- # @param [Object] issue_number Value to be assigned
272
- def issue_number=(issue_number)
273
- @issue_number = issue_number
274
- end
275
-
276
- # Custom attribute writer method with validation
277
- # @param [Object] start_month Value to be assigned
278
- def start_month=(start_month)
279
- @start_month = start_month
280
- end
281
-
282
- # Custom attribute writer method with validation
283
- # @param [Object] start_year Value to be assigned
284
- def start_year=(start_year)
285
- @start_year = start_year
286
- end
287
-
288
- # Custom attribute writer method with validation
289
- # @param [Object] product_name Value to be assigned
290
- def product_name=(product_name)
291
- @product_name = product_name
292
- end
293
-
294
- # Custom attribute writer method with validation
295
- # @param [Object] product_subtype Value to be assigned
296
- def product_subtype=(product_subtype)
297
- @product_subtype = product_subtype
298
- end
299
-
300
- # Custom attribute writer method with validation
301
- # @param [Object] type_selection_indicator Value to be assigned
302
- def type_selection_indicator=(type_selection_indicator)
303
- @type_selection_indicator = type_selection_indicator
304
- end
305
-
306
- # Checks equality by comparing each attribute.
307
- # @param [Object] Object to be compared
308
- def ==(o)
309
- return true if self.equal?(o)
310
- self.class == o.class &&
311
- number == o.number &&
312
- expiration_month == o.expiration_month &&
313
- expiration_year == o.expiration_year &&
314
- type == o.type &&
315
- use_as == o.use_as &&
316
- source_account_type == o.source_account_type &&
317
- source_account_type_details == o.source_account_type_details &&
318
- security_code == o.security_code &&
319
- security_code_indicator == o.security_code_indicator &&
320
- account_encoder_id == o.account_encoder_id &&
321
- issue_number == o.issue_number &&
322
- start_month == o.start_month &&
323
- start_year == o.start_year &&
324
- product_name == o.product_name &&
325
- product_subtype == o.product_subtype &&
326
- type_selection_indicator == o.type_selection_indicator
327
- end
328
-
329
- # @see the `==` method
330
- # @param [Object] Object to be compared
331
- def eql?(o)
332
- self == o
333
- end
334
-
335
- # Calculates hash code according to all attributes.
336
- # @return [Fixnum] Hash code
337
- def hash
338
- [number, expiration_month, expiration_year, type, use_as, source_account_type, source_account_type_details, security_code, security_code_indicator, account_encoder_id, issue_number, start_month, start_year, product_name, product_subtype, type_selection_indicator].hash
339
- end
340
-
341
- # Builds the object from hash
342
- # @param [Hash] attributes Model attributes in the form of hash
343
- # @return [Object] Returns the model itself
344
- def build_from_hash(attributes)
345
- return nil unless attributes.is_a?(Hash)
346
- self.class.swagger_types.each_pair do |key, type|
347
- if type =~ /\AArray<(.*)>/i
348
- # check to ensure the input is an array given that the the attribute
349
- # is documented as an array but the input is not
350
- if attributes[self.class.attribute_map[key]].is_a?(Array)
351
- self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
352
- end
353
- elsif !attributes[self.class.attribute_map[key]].nil?
354
- self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
355
- end # or else data not found in attributes(hash), not an issue as the data can be optional
356
- end
357
-
358
- self
359
- end
360
-
361
- # Deserializes the data based on type
362
- # @param string type Data type
363
- # @param string value Value to be deserialized
364
- # @return [Object] Deserialized data
365
- def _deserialize(type, value)
366
- case type.to_sym
367
- when :DateTime
368
- DateTime.parse(value)
369
- when :Date
370
- Date.parse(value)
371
- when :String
372
- value.to_s
373
- when :Integer
374
- value.to_i
375
- when :Float
376
- value.to_f
377
- when :BOOLEAN
378
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
379
- true
380
- else
381
- false
382
- end
383
- when :Object
384
- # generic object (usually a Hash), return directly
385
- value
386
- when /\AArray<(?<inner_type>.+)>\z/
387
- inner_type = Regexp.last_match[:inner_type]
388
- value.map { |v| _deserialize(inner_type, v) }
389
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
390
- k_type = Regexp.last_match[:k_type]
391
- v_type = Regexp.last_match[:v_type]
392
- {}.tap do |hash|
393
- value.each do |k, v|
394
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
395
- end
396
- end
397
- else # model
398
- temp_model = CyberSource.const_get(type).new
399
- temp_model.build_from_hash(value)
400
- end
401
- end
402
-
403
- # Returns the string representation of the object
404
- # @return [String] String presentation of the object
405
- def to_s
406
- to_hash.to_s
407
- end
408
-
409
- # to_body is an alias to to_hash (backward compatibility)
410
- # @return [Hash] Returns the object in the form of hash
411
- def to_body
412
- to_hash
413
- end
414
-
415
- # Returns the object in the form of hash
416
- # @return [Hash] Returns the object in the form of hash
417
- def to_hash
418
- hash = {}
419
- self.class.attribute_map.each_pair do |attr, param|
420
- value = self.send(attr)
421
- next if value.nil?
422
- hash[param] = _to_hash(value)
423
- end
424
- hash
425
- end
426
-
427
- # Outputs non-array value in the form of hash
428
- # For object, use to_hash. Otherwise, just return the value
429
- # @param [Object] value Any valid value
430
- # @return [Hash] Returns the value in the form of hash
431
- def _to_hash(value)
432
- if value.is_a?(Array)
433
- value.compact.map { |v| _to_hash(v) }
434
- elsif value.is_a?(Hash)
435
- {}.tap do |hash|
436
- value.each { |k, v| hash[k] = _to_hash(v) }
437
- end
438
- elsif value.respond_to? :to_hash
439
- value.to_hash
440
- else
441
- value
442
- end
443
- end
444
- end
445
- end
1
+ =begin
2
+ #CyberSource Merged Spec
3
+
4
+ #All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
5
+
6
+ OpenAPI spec version: 0.0.1
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.38
10
+ =end
11
+
12
+ require 'date'
13
+
14
+ module CyberSource
15
+ class Ptsv2paymentsPaymentInformationCard
16
+ # The customer's payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. #### FDMS Nashville Required. String (19) #### GPX Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.
17
+ attr_accessor :number
18
+
19
+ # Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. Leading 0 is required. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response.
20
+ attr_accessor :expiration_month
21
+
22
+ # Four-digit year in which the payment card expires. Format: `YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### FDMS Nashville Required field. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response.
23
+ attr_accessor :expiration_year
24
+
25
+ # Three-digit value that indicates the card type. **IMPORTANT** It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - `001`: Visa. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche[^1] - `007`: JCB[^1] - `008`: Optima - `009`: GE Private Label - `010`: Beneficial Private Label - `011`: Twinpay Credit Card - `012`: Twinpay Debit Card - `013`: WalMart - `014`: Enroute[^1] - `015`: Lowe's Consumer - `016`: Home Depot Consumer - `017`: MBNA - `018`: Dick's Sportswear - `019`: Casual Corner - `020`: Sears - `021`: JAL[^1] - `023`: Disney Card - `024`: Maestro (UK Domestic)[^1] - `025`: Sam's Club Consumer - `026`: Sam's Club Business - `027`: Nico's - `028`: Paymentech Bill Me Later - `029`: Bebe - `030`: Restoration Hardware - `031`: Delta Online - `032`: Solo - `033`: Visa Electron[^1]. Do not use this value. Use `001` for all Visa card types. - `034`: Dankort[^1] - `035`: Laser - `036`: Cartes Bancaires[^1,4] - `037`: Carta Si[^1] - `038`: Pinless Debit - `039`: Encoded account number[^1] - `040`: UATP[^1] - `041`: HOUSEHOLD - `042`: Maestro (International)[^1] - `043`: GE MONEY - `044`: Korean Cards - `045`: Style Cards - `046`: JCrew - `047`: Payeasecn eWallet - `048`: Payeasecn Bank Transfer - `049`: Meijer - `050`: Hipercard[^2,3] - `051`: Aura - `052`: Redecard - `053`: Orico card - `054`: Elo[^3] - `055`: Capitol One Private Label - `056`: Carnet - `057`: Costco Private Label - `058`: Carnet - `059`: ValueLink - `060`: MADA - `061`: RuPay - `062`: China UnionPay - `063`: Falabella Private Label - `064`: Prompt Card - `065`: Korean Domestic - `066`: Banricompras - `067`: MEEZA - `068`: PayPak - `070`: EFTPOS - `071`: Codensa - `072`: Olimpica - `073`: Colsubsidio - `074`: Tuya - `075`: Sodexo - `076`: Naranja - `077`: Cabal - `078`: DINELCO - `079`: PANAL - `080`: EPM - `081`: Jaywan [^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by **Authorization** Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International
26
+ attr_accessor :type
27
+
28
+ # Flag that specifies the type of account associated with the card. This field is available only for China UnionPay, Cielo, Comercio Latino and Visa Platform Connect. The cardholder provides this information during the payment process. This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **China UnionPayCard Transactions on China UnionPay:** Possible values: - C: Domestic credit card - D: Domestic debit card - F: International credit card - I: International debit card When the value is D, the e-commerce indicator and CAVV fields must be included in the authorization request. When the value is C, F or I the card verification number, expiration month and expiration year fields must in included in the authorization request. **Cielo and Comercio Latino Credit Card Transactions:** On these processors, this field is supported only for authorizations. Possible values: - CR: Credit card - DB: Debit card **Visa Platform Connect Credit Card Transactions:** This field is supported for all card types on Visa Platform Connect. For combo **card present** transactions with Mastercard on Brazilian-issued cards, possible values: - CR: Credit card - DB: Debit Card For combo **card not present** transactions with Mastercard on Brazilian-issued cards, possible values: - C: Credit card - D: Debit card A value of CR or DB in the useAs field takes precedence over any value in the Source Account Type field.
29
+ attr_accessor :use_as
30
+
31
+ # Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for CyberSource through VisaNet (CtV). **Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - `CH`: Checking account - `CR`: Credit card account - `SA`: Saving account - `LI`: Line of credit or credit portion of combo card - `PP`: Prepaid card account or prepaid portion of combo card - `UA`: Universal account If useAs is set to credit/debit and there is a value in SourceAccountType, the value in the SourceAccountType field will take precedence. If useAs is set to CR/DB and there is a value in SourceAccountType, the value in the useAs field will take precedence.
32
+ attr_accessor :source_account_type
33
+
34
+ # Type of account that is being used when the value for the override_payment_method field is line of credit (LI) or prepaid card (PP). Possible values for line of credit: - `AGRC`: Visa Agro Custeio - `AGRE`: Visa Agro Electron - `AGRI`: Visa Agro Investimento - `AGRO`: Visa Agro Possible values for prepaid card: - `VVA`: Visa Vale Alimentacao - `VVF`: Visa Vale Flex - `VVR`: Visa Vale Refeicao This field is supported only for combo card transactions in Brazil on CyberSource through VisaNet.
35
+ attr_accessor :source_account_type_details
36
+
37
+ # Card Verification Number. #### FDMS Nashville Required for American Express or if swiped; otherwise, optional. #### Ingenico ePayments Do not include this field when `commerceIndicator=recurring`. **Note** Ingenico ePayments was previously called _Global Collect_. #### TSYS Acquiring Solutions Optional if pointOfSaleInformation.entryMode=keyed; otherwise, not used. #### GPX Optional. #### All other processors: Optional.
38
+ attr_accessor :security_code
39
+
40
+ # Indicates whether a CVN code was sent. Possible values: - `0` (default): CVN service not requested. This default value is used when you do not include `securityCode` field in the request. - `1` (default): CVN service requested and supported. This default value is used when you include `securityCode` field in the request. - `2`: CVN on credit card is illegible. - `9`: CVN was not imprinted on credit card. #### FDMS Nashville Required for American Express cards; otherwise, optional. #### TSYS Acquiring Solutions Optional if `pointOfSaleInformation.entryMode=keyed`; otherwise, not used. #### All other processors Optional.
41
+ attr_accessor :security_code_indicator
42
+
43
+ # Identifier for the issuing bank that provided the customer's encoded account number. Contact your processor for the bank's ID.
44
+ attr_accessor :account_encoder_id
45
+
46
+ # Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions.
47
+ attr_accessor :issue_number
48
+
49
+ # Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions.
50
+ attr_accessor :start_month
51
+
52
+ # Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions.
53
+ attr_accessor :start_year
54
+
55
+ # Name of the card product. Possible value: - BNDES This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 115-120 - Field: Brazil Country Data
56
+ attr_accessor :product_name
57
+
58
+ # This field would contain the indicator for transaction type Possible values: - AC: Agriculture Maintenance Account - AE: Agriculture Debit Account/Electron - AG: Agriculture - AI: Agriculture Investment Loan - CG: Brazil Cargo - CS: Construction - DS: Distribution - HC: Healthcare - LP: Visa Large Purchase Advantage - MA: Visa Mobile Agent - MB: Interoperable Mobile Branchless Banking - MG: Visa Mobile General - VA: Visa Vale - Supermarket - VF: Visa Vale - Fuel - VR: Visa Vale - Restaurant
59
+ attr_accessor :product_subtype
60
+
61
+ # Flag that identifies how the card type was selected. Possible values: - 0: Card type was selected based on default acquirer settings. - 1: Customer selected the card type.
62
+ attr_accessor :type_selection_indicator
63
+
64
+ # Attribute mapping from ruby-style variable name to JSON key.
65
+ def self.attribute_map
66
+ {
67
+ :'number' => :'number',
68
+ :'expiration_month' => :'expirationMonth',
69
+ :'expiration_year' => :'expirationYear',
70
+ :'type' => :'type',
71
+ :'use_as' => :'useAs',
72
+ :'source_account_type' => :'sourceAccountType',
73
+ :'source_account_type_details' => :'sourceAccountTypeDetails',
74
+ :'security_code' => :'securityCode',
75
+ :'security_code_indicator' => :'securityCodeIndicator',
76
+ :'account_encoder_id' => :'accountEncoderId',
77
+ :'issue_number' => :'issueNumber',
78
+ :'start_month' => :'startMonth',
79
+ :'start_year' => :'startYear',
80
+ :'product_name' => :'productName',
81
+ :'product_subtype' => :'productSubtype',
82
+ :'type_selection_indicator' => :'typeSelectionIndicator'
83
+ }
84
+ end
85
+
86
+ # Attribute mapping from JSON key to ruby-style variable name.
87
+ def self.json_map
88
+ {
89
+ :'number' => :'number',
90
+ :'expiration_month' => :'expiration_month',
91
+ :'expiration_year' => :'expiration_year',
92
+ :'type' => :'type',
93
+ :'use_as' => :'use_as',
94
+ :'source_account_type' => :'source_account_type',
95
+ :'source_account_type_details' => :'source_account_type_details',
96
+ :'security_code' => :'security_code',
97
+ :'security_code_indicator' => :'security_code_indicator',
98
+ :'account_encoder_id' => :'account_encoder_id',
99
+ :'issue_number' => :'issue_number',
100
+ :'start_month' => :'start_month',
101
+ :'start_year' => :'start_year',
102
+ :'product_name' => :'product_name',
103
+ :'product_subtype' => :'product_subtype',
104
+ :'type_selection_indicator' => :'type_selection_indicator'
105
+ }
106
+ end
107
+
108
+ # Attribute type mapping.
109
+ def self.swagger_types
110
+ {
111
+ :'number' => :'String',
112
+ :'expiration_month' => :'String',
113
+ :'expiration_year' => :'String',
114
+ :'type' => :'String',
115
+ :'use_as' => :'String',
116
+ :'source_account_type' => :'String',
117
+ :'source_account_type_details' => :'String',
118
+ :'security_code' => :'String',
119
+ :'security_code_indicator' => :'String',
120
+ :'account_encoder_id' => :'String',
121
+ :'issue_number' => :'String',
122
+ :'start_month' => :'String',
123
+ :'start_year' => :'String',
124
+ :'product_name' => :'String',
125
+ :'product_subtype' => :'String',
126
+ :'type_selection_indicator' => :'String'
127
+ }
128
+ end
129
+
130
+ # Initializes the object
131
+ # @param [Hash] attributes Model attributes in the form of hash
132
+ def initialize(attributes = {})
133
+ return unless attributes.is_a?(Hash)
134
+
135
+ # convert string to symbol for hash key
136
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
137
+
138
+ if attributes.has_key?(:'number')
139
+ self.number = attributes[:'number']
140
+ end
141
+
142
+ if attributes.has_key?(:'expirationMonth')
143
+ self.expiration_month = attributes[:'expirationMonth']
144
+ end
145
+
146
+ if attributes.has_key?(:'expirationYear')
147
+ self.expiration_year = attributes[:'expirationYear']
148
+ end
149
+
150
+ if attributes.has_key?(:'type')
151
+ self.type = attributes[:'type']
152
+ end
153
+
154
+ if attributes.has_key?(:'useAs')
155
+ self.use_as = attributes[:'useAs']
156
+ end
157
+
158
+ if attributes.has_key?(:'sourceAccountType')
159
+ self.source_account_type = attributes[:'sourceAccountType']
160
+ end
161
+
162
+ if attributes.has_key?(:'sourceAccountTypeDetails')
163
+ self.source_account_type_details = attributes[:'sourceAccountTypeDetails']
164
+ end
165
+
166
+ if attributes.has_key?(:'securityCode')
167
+ self.security_code = attributes[:'securityCode']
168
+ end
169
+
170
+ if attributes.has_key?(:'securityCodeIndicator')
171
+ self.security_code_indicator = attributes[:'securityCodeIndicator']
172
+ end
173
+
174
+ if attributes.has_key?(:'accountEncoderId')
175
+ self.account_encoder_id = attributes[:'accountEncoderId']
176
+ end
177
+
178
+ if attributes.has_key?(:'issueNumber')
179
+ self.issue_number = attributes[:'issueNumber']
180
+ end
181
+
182
+ if attributes.has_key?(:'startMonth')
183
+ self.start_month = attributes[:'startMonth']
184
+ end
185
+
186
+ if attributes.has_key?(:'startYear')
187
+ self.start_year = attributes[:'startYear']
188
+ end
189
+
190
+ if attributes.has_key?(:'productName')
191
+ self.product_name = attributes[:'productName']
192
+ end
193
+
194
+ if attributes.has_key?(:'productSubtype')
195
+ self.product_subtype = attributes[:'productSubtype']
196
+ end
197
+
198
+ if attributes.has_key?(:'typeSelectionIndicator')
199
+ self.type_selection_indicator = attributes[:'typeSelectionIndicator']
200
+ end
201
+ end
202
+
203
+ # Show invalid properties with the reasons. Usually used together with valid?
204
+ # @return Array for valid properties with the reasons
205
+ def list_invalid_properties
206
+ invalid_properties = Array.new
207
+ invalid_properties
208
+ end
209
+
210
+ # Check to see if the all the properties in the model are valid
211
+ # @return true if the model is valid
212
+ def valid?
213
+ true
214
+ end
215
+
216
+ # Custom attribute writer method with validation
217
+ # @param [Object] number Value to be assigned
218
+ def number=(number)
219
+ @number = number
220
+ end
221
+
222
+ # Custom attribute writer method with validation
223
+ # @param [Object] expiration_month Value to be assigned
224
+ def expiration_month=(expiration_month)
225
+ @expiration_month = expiration_month
226
+ end
227
+
228
+ # Custom attribute writer method with validation
229
+ # @param [Object] expiration_year Value to be assigned
230
+ def expiration_year=(expiration_year)
231
+ @expiration_year = expiration_year
232
+ end
233
+
234
+ # Custom attribute writer method with validation
235
+ # @param [Object] use_as Value to be assigned
236
+ def use_as=(use_as)
237
+ @use_as = use_as
238
+ end
239
+
240
+ # Custom attribute writer method with validation
241
+ # @param [Object] source_account_type Value to be assigned
242
+ def source_account_type=(source_account_type)
243
+ @source_account_type = source_account_type
244
+ end
245
+
246
+ # Custom attribute writer method with validation
247
+ # @param [Object] source_account_type_details Value to be assigned
248
+ def source_account_type_details=(source_account_type_details)
249
+ @source_account_type_details = source_account_type_details
250
+ end
251
+
252
+ # Custom attribute writer method with validation
253
+ # @param [Object] security_code Value to be assigned
254
+ def security_code=(security_code)
255
+ @security_code = security_code
256
+ end
257
+
258
+ # Custom attribute writer method with validation
259
+ # @param [Object] security_code_indicator Value to be assigned
260
+ def security_code_indicator=(security_code_indicator)
261
+ @security_code_indicator = security_code_indicator
262
+ end
263
+
264
+ # Custom attribute writer method with validation
265
+ # @param [Object] account_encoder_id Value to be assigned
266
+ def account_encoder_id=(account_encoder_id)
267
+ @account_encoder_id = account_encoder_id
268
+ end
269
+
270
+ # Custom attribute writer method with validation
271
+ # @param [Object] issue_number Value to be assigned
272
+ def issue_number=(issue_number)
273
+ @issue_number = issue_number
274
+ end
275
+
276
+ # Custom attribute writer method with validation
277
+ # @param [Object] start_month Value to be assigned
278
+ def start_month=(start_month)
279
+ @start_month = start_month
280
+ end
281
+
282
+ # Custom attribute writer method with validation
283
+ # @param [Object] start_year Value to be assigned
284
+ def start_year=(start_year)
285
+ @start_year = start_year
286
+ end
287
+
288
+ # Custom attribute writer method with validation
289
+ # @param [Object] product_name Value to be assigned
290
+ def product_name=(product_name)
291
+ @product_name = product_name
292
+ end
293
+
294
+ # Custom attribute writer method with validation
295
+ # @param [Object] product_subtype Value to be assigned
296
+ def product_subtype=(product_subtype)
297
+ @product_subtype = product_subtype
298
+ end
299
+
300
+ # Custom attribute writer method with validation
301
+ # @param [Object] type_selection_indicator Value to be assigned
302
+ def type_selection_indicator=(type_selection_indicator)
303
+ @type_selection_indicator = type_selection_indicator
304
+ end
305
+
306
+ # Checks equality by comparing each attribute.
307
+ # @param [Object] Object to be compared
308
+ def ==(o)
309
+ return true if self.equal?(o)
310
+ self.class == o.class &&
311
+ number == o.number &&
312
+ expiration_month == o.expiration_month &&
313
+ expiration_year == o.expiration_year &&
314
+ type == o.type &&
315
+ use_as == o.use_as &&
316
+ source_account_type == o.source_account_type &&
317
+ source_account_type_details == o.source_account_type_details &&
318
+ security_code == o.security_code &&
319
+ security_code_indicator == o.security_code_indicator &&
320
+ account_encoder_id == o.account_encoder_id &&
321
+ issue_number == o.issue_number &&
322
+ start_month == o.start_month &&
323
+ start_year == o.start_year &&
324
+ product_name == o.product_name &&
325
+ product_subtype == o.product_subtype &&
326
+ type_selection_indicator == o.type_selection_indicator
327
+ end
328
+
329
+ # @see the `==` method
330
+ # @param [Object] Object to be compared
331
+ def eql?(o)
332
+ self == o
333
+ end
334
+
335
+ # Calculates hash code according to all attributes.
336
+ # @return [Fixnum] Hash code
337
+ def hash
338
+ [number, expiration_month, expiration_year, type, use_as, source_account_type, source_account_type_details, security_code, security_code_indicator, account_encoder_id, issue_number, start_month, start_year, product_name, product_subtype, type_selection_indicator].hash
339
+ end
340
+
341
+ # Builds the object from hash
342
+ # @param [Hash] attributes Model attributes in the form of hash
343
+ # @return [Object] Returns the model itself
344
+ def build_from_hash(attributes)
345
+ return nil unless attributes.is_a?(Hash)
346
+ self.class.swagger_types.each_pair do |key, type|
347
+ if type =~ /\AArray<(.*)>/i
348
+ # check to ensure the input is an array given that the the attribute
349
+ # is documented as an array but the input is not
350
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
351
+ self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
352
+ end
353
+ elsif !attributes[self.class.attribute_map[key]].nil?
354
+ self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
355
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
356
+ end
357
+
358
+ self
359
+ end
360
+
361
+ # Deserializes the data based on type
362
+ # @param string type Data type
363
+ # @param string value Value to be deserialized
364
+ # @return [Object] Deserialized data
365
+ def _deserialize(type, value)
366
+ case type.to_sym
367
+ when :DateTime
368
+ DateTime.parse(value)
369
+ when :Date
370
+ Date.parse(value)
371
+ when :String
372
+ value.to_s
373
+ when :Integer
374
+ value.to_i
375
+ when :Float
376
+ value.to_f
377
+ when :BOOLEAN
378
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
379
+ true
380
+ else
381
+ false
382
+ end
383
+ when :Object
384
+ # generic object (usually a Hash), return directly
385
+ value
386
+ when /\AArray<(?<inner_type>.+)>\z/
387
+ inner_type = Regexp.last_match[:inner_type]
388
+ value.map { |v| _deserialize(inner_type, v) }
389
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
390
+ k_type = Regexp.last_match[:k_type]
391
+ v_type = Regexp.last_match[:v_type]
392
+ {}.tap do |hash|
393
+ value.each do |k, v|
394
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
395
+ end
396
+ end
397
+ else # model
398
+ temp_model = CyberSource.const_get(type).new
399
+ temp_model.build_from_hash(value)
400
+ end
401
+ end
402
+
403
+ # Returns the string representation of the object
404
+ # @return [String] String presentation of the object
405
+ def to_s
406
+ to_hash.to_s
407
+ end
408
+
409
+ # to_body is an alias to to_hash (backward compatibility)
410
+ # @return [Hash] Returns the object in the form of hash
411
+ def to_body
412
+ to_hash
413
+ end
414
+
415
+ # Returns the object in the form of hash
416
+ # @return [Hash] Returns the object in the form of hash
417
+ def to_hash
418
+ hash = {}
419
+ self.class.attribute_map.each_pair do |attr, param|
420
+ value = self.send(attr)
421
+ next if value.nil?
422
+ hash[param] = _to_hash(value)
423
+ end
424
+ hash
425
+ end
426
+
427
+ # Outputs non-array value in the form of hash
428
+ # For object, use to_hash. Otherwise, just return the value
429
+ # @param [Object] value Any valid value
430
+ # @return [Hash] Returns the value in the form of hash
431
+ def _to_hash(value)
432
+ if value.is_a?(Array)
433
+ value.compact.map { |v| _to_hash(v) }
434
+ elsif value.is_a?(Hash)
435
+ {}.tap do |hash|
436
+ value.each { |k, v| hash[k] = _to_hash(v) }
437
+ end
438
+ elsif value.respond_to? :to_hash
439
+ value.to_hash
440
+ else
441
+ value
442
+ end
443
+ end
444
+ end
445
+ end