Class: CyberSourceMergedSpec::ProcessingInformation

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/cyber_source_merged_spec/models/processing_information.rb

Overview

ProcessingInformation Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(action_list: SKIP, enable_escrow_option: SKIP, action_token_types: SKIP, bin_source: SKIP, capture: false, processor_id: SKIP, business_application_id: SKIP, commerce_indicator: SKIP, commerce_indicator_label: SKIP, payment_solution: SKIP, reconciliation_id: SKIP, link_id: SKIP, purchase_level: SKIP, transaction_timeout: SKIP, intents_id: SKIP, report_group: SKIP, visa_checkout_id: SKIP, industry_data_type: SKIP, authorization_options: SKIP, card_verification: SKIP, capture_options: SKIP, recurring_options: SKIP, bank_transfer_options: SKIP, purchase_options: SKIP, electronic_benefits_transfer: SKIP, loan_options: SKIP, wallet_type: SKIP, national_net_domestic_data: SKIP, merchant_verification_value: SKIP, japan_payment_options: SKIP, mobile_remote_payment_type: SKIP, extended_credit_total_count: SKIP, network_routing_order: SKIP, pay_by_points_indicator: SKIP, timeout: SKIP, is_return_auth_record_enabled: SKIP, network_partner_id: SKIP, payment_type: SKIP, enabler_id: SKIP, processing_instruction: SKIP, transaction_type_indicator: SKIP, purpose_of_payment: SKIP, language_code: SKIP, original_payment_id: SKIP, amex_indirect_model_type: SKIP, wallet_transaction_intent: SKIP, destination_type: SKIP, program_indicators: SKIP, inquiry_type: SKIP, additional_properties: nil) ⇒ ProcessingInformation

Returns a new instance of ProcessingInformation.



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 754

def initialize(action_list: SKIP, enable_escrow_option: SKIP,
               action_token_types: SKIP, bin_source: SKIP, capture: false,
               processor_id: SKIP, business_application_id: SKIP,
               commerce_indicator: SKIP, commerce_indicator_label: SKIP,
               payment_solution: SKIP, reconciliation_id: SKIP,
               link_id: SKIP, purchase_level: SKIP,
               transaction_timeout: SKIP, intents_id: SKIP,
               report_group: SKIP, visa_checkout_id: SKIP,
               industry_data_type: SKIP, authorization_options: SKIP,
               card_verification: SKIP, capture_options: SKIP,
               recurring_options: SKIP, bank_transfer_options: SKIP,
               purchase_options: SKIP, electronic_benefits_transfer: SKIP,
               loan_options: SKIP, wallet_type: SKIP,
               national_net_domestic_data: SKIP,
               merchant_verification_value: SKIP,
               japan_payment_options: SKIP,
               mobile_remote_payment_type: SKIP,
               extended_credit_total_count: SKIP,
               network_routing_order: SKIP, pay_by_points_indicator: SKIP,
               timeout: SKIP, is_return_auth_record_enabled: SKIP,
               network_partner_id: SKIP, payment_type: SKIP,
               enabler_id: SKIP, processing_instruction: SKIP,
               transaction_type_indicator: SKIP, purpose_of_payment: SKIP,
               language_code: SKIP, original_payment_id: SKIP,
               amex_indirect_model_type: SKIP,
               wallet_transaction_intent: SKIP, destination_type: SKIP,
               program_indicators: SKIP, inquiry_type: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @action_list = action_list unless action_list == SKIP
  @enable_escrow_option = enable_escrow_option unless enable_escrow_option == SKIP
  @action_token_types = action_token_types unless action_token_types == SKIP
  @bin_source = bin_source unless bin_source == SKIP
  @capture = capture unless capture == SKIP
  @processor_id = processor_id unless processor_id == SKIP
  @business_application_id = business_application_id unless business_application_id == SKIP
  @commerce_indicator = commerce_indicator unless commerce_indicator == SKIP
  @commerce_indicator_label = commerce_indicator_label unless commerce_indicator_label == SKIP
  @payment_solution = payment_solution unless payment_solution == SKIP
  @reconciliation_id = reconciliation_id unless reconciliation_id == SKIP
  @link_id = link_id unless link_id == SKIP
  @purchase_level = purchase_level unless purchase_level == SKIP
  @transaction_timeout = transaction_timeout unless transaction_timeout == SKIP
  @intents_id = intents_id unless intents_id == SKIP
  @report_group = report_group unless report_group == SKIP
  @visa_checkout_id = visa_checkout_id unless visa_checkout_id == SKIP
  @industry_data_type = industry_data_type unless industry_data_type == SKIP
  @authorization_options = authorization_options unless authorization_options == SKIP
  @card_verification = card_verification unless card_verification == SKIP
  @capture_options = capture_options unless capture_options == SKIP
  @recurring_options = recurring_options unless recurring_options == SKIP
  @bank_transfer_options = bank_transfer_options unless bank_transfer_options == SKIP
  @purchase_options = purchase_options unless purchase_options == SKIP
  unless electronic_benefits_transfer == SKIP
    @electronic_benefits_transfer =
      electronic_benefits_transfer
  end
  @loan_options = loan_options unless loan_options == SKIP
  @wallet_type = wallet_type unless wallet_type == SKIP
  unless national_net_domestic_data == SKIP
    @national_net_domestic_data =
      national_net_domestic_data
  end
  unless merchant_verification_value == SKIP
    @merchant_verification_value =
      merchant_verification_value
  end
  @japan_payment_options = japan_payment_options unless japan_payment_options == SKIP
  unless mobile_remote_payment_type == SKIP
    @mobile_remote_payment_type =
      mobile_remote_payment_type
  end
  unless extended_credit_total_count == SKIP
    @extended_credit_total_count =
      extended_credit_total_count
  end
  @network_routing_order = network_routing_order unless network_routing_order == SKIP
  @pay_by_points_indicator = pay_by_points_indicator unless pay_by_points_indicator == SKIP
  @timeout = timeout unless timeout == SKIP
  unless is_return_auth_record_enabled == SKIP
    @is_return_auth_record_enabled =
      is_return_auth_record_enabled
  end
  @network_partner_id = network_partner_id unless network_partner_id == SKIP
  @payment_type = payment_type unless payment_type == SKIP
  @enabler_id = enabler_id unless enabler_id == SKIP
  @processing_instruction = processing_instruction unless processing_instruction == SKIP
  unless transaction_type_indicator == SKIP
    @transaction_type_indicator =
      transaction_type_indicator
  end
  @purpose_of_payment = purpose_of_payment unless purpose_of_payment == SKIP
  @language_code = language_code unless language_code == SKIP
  @original_payment_id = original_payment_id unless original_payment_id == SKIP
  @amex_indirect_model_type = amex_indirect_model_type unless amex_indirect_model_type == SKIP
  unless wallet_transaction_intent == SKIP
    @wallet_transaction_intent =
      wallet_transaction_intent
  end
  @destination_type = destination_type unless destination_type == SKIP
  @program_indicators = program_indicators unless program_indicators == SKIP
  @inquiry_type = inquiry_type unless inquiry_type == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#action_list ⇒ Array[String]

Array of actions (one or more) to be included in the payment to invoke bundled services along with payment. Possible values are one or more of follows:

  • DECISION_SKIP: Use this when you want to skip Decision Manager service(s).

  • TOKEN_CREATE: Use this when you want to create a token from the card/bank data in your payment request.

  • CONSUMER_AUTHENTICATION: Use this when you want to check if a card is enrolled in Payer Authentication along with your payment request.

  • VALIDATE_CONSUMER_AUTHENTICATION: Use this after you acquire a Payer Authentication result that needs to be included for your payment request.

  • AP_INITIATE: Use this when Alternative Payment Initiate service is requested.

  • WATCHLIST_SCREENING : Use this when you want to call Watchlist Screening service.

  • AP_SALE : Use this when Alternative Payment Sale service is requested.

  • AP_AUTH : Use this when Alternative Payment Authorize service is requested.

  • AP_REAUTH : Use this when Alternative Payment Reauthorize service is requested.

Returns:

  • (Array[String]) 


35
36
37
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 35

def action_list
  @action_list
end

#action_token_types ⇒ Array[String]

CyberSource tokens types you are performing a create on. If not supplied the default token type for the merchants token vault will be used. Valid values:

  • customer
  • paymentInstrument
  • instrumentIdentifier
  • shippingAddress

Returns:

  • (Array[String]) 


53
54
55
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 53

def action_token_types
  @action_token_types
end

#amex_indirect_model_type ⇒ String

Effective with the April 2025 release, American Express is introducing the following new Indirect Acceptor models :

  • Digital Wallet Operator
    • Staged back to back transaction
    • Peer to peer (P2P) transaction
    • Stored value transaction
  • Marketplace Each model must have a separate American Express Merchant Account number and will be assigned a unique Indirect Model Type value. Valid/Sample Values :
  • 1: Bill payment provider
  • 2: Installment payment transaction
  • 3: Marketplace
  • 4: Peer to peer transaction
  • 5: Staged back to back transaction
  • 6: Stored value transaction

Returns:

  • (String) 


595
596
597
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 595

def amex_indirect_model_type
  @amex_indirect_model_type
end

#authorization_options ⇒ ProcessingInfOauthOrizationOptions

Indicates that the transaction includes industry-specific data. Possible Values:

  • airline
  • restaurant
  • lodging
  • auto_rental
  • transit
  • healthcare_medical
  • healthcare_transit
  • transit

Card Present, Airlines and Auto Rental

You must set this field to airline in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, no airline data is sent to the processor. You must set this field to restaurant in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, no restaurant data is sent to the processor. You must set this field to auto_rental in order for auto rental data to be sent to the processor. For example, if this field is not set to auto_rental or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet.

Returns:



278
279
280
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 278

def authorization_options
  @authorization_options
end

#bank_transfer_options ⇒ BankTransferOptions

Contains card verification control flags for transaction-level verification settings.

Returns:



298
299
300
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 298

def bank_transfer_options
  @bank_transfer_options
end

#bin_source ⇒ String

Bin Source File Identifier. Possible values:

  • itmx
  • rupay

Returns:

  • (String) 


60
61
62
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 60

def bin_source
  @bin_source
end

#business_application_id ⇒ String

Required for AFT and OCT transactions. Given below is a list of all the BAI values available. However, the processors may support only few specific BAI values.

  • AA : Account-to-account
  • BB : Supplier Payments
  • BI : Bank-Initiated P2P Money Transfer
  • BP : Non-Card Bill Pay/Bill Pay
  • CD : Cash Deposit
  • CP : Credit card Bill Payment
  • FD : Funds disbursement
  • FT : Funds transfer
  • GD : Government Disbursement
  • GP : Gambling payout (non-online gambling)
  • LO : Loyalty credits and rebates
  • MD : Merchant Settlement
  • OG : Online Gambling Payout
  • PD : Payroll and pension disbursement
  • PP : Person-to-Person or Peer-to-Peer
  • TU : Top up, prepaid load
  • WT : Digital wallet

Returns:

  • (String) 


102
103
104
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 102

def business_application_id
  @business_application_id
end

#capture ⇒ TrueClass | FalseClass

Indicates whether to also include a capture in the submitted authorization request or not. Possible values:

  • true: Include a capture with an authorization request.
  • false: (default) Do not include a capture with an authorization request.

Used by

Authorization and Capture Optional field.

Returns:

  • (TrueClass | FalseClass) 


72
73
74
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 72

def capture
  @capture
end

#capture_options ⇒ CaptureOptions

Contains card verification control flags for transaction-level verification settings.

Returns:



288
289
290
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 288

def capture_options
  @capture_options
end

#card_verification ⇒ CardVerification

Contains card verification control flags for transaction-level verification settings.

Returns:



283
284
285
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 283

def card_verification
  @card_verification
end

#commerce_indicator ⇒ String

Type of transaction. Some payment card companies use this information when determining discount rates.

Used by

Authorization Required payer authentication transactions; otherwise, optional. Credit Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor.

Ingenico ePayments

When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value

Card Present

You must set this field to retail. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as “moto"

Returns:

  • (String) 


126
127
128
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 126

def commerce_indicator
  @commerce_indicator
end

#commerce_indicator_label ⇒ String

Type of transaction. Some payment card companies use this information when determining discount rates.

Used by

Authorization Required payer authentication transactions; otherwise, optional. Credit Required for standalone credits on Chase Paymentech solutions; otherwise, optional. The list of valid values in this field depends on your processor.

Ingenico ePayments

When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value

Card Present

You must set this field to retail. This field is required for a card-present transaction. Note that this should ONLY be used when the cardholder and card are present at the time of the transaction. For all keyed transactions originated from a POS terminal where the cardholder and card are not present, commerceIndicator should be submitted as moto

Returns:

  • (String) 


150
151
152
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 150

def commerce_indicator_label
  @commerce_indicator_label
end

#destination_type ⇒ Float

Identifies the destination/purpose of the cash-in: • 04: M2M (Same ownership, same portfolio/arrangement) • 05: P2P (For another holder, same wallet/arrangement) • 06: Transfer to another arrangement (same ownership) • 07: Transfer to another arrangement (other ownership) • 08: Transfer to stored value digital wallet.

Returns:

  • (Float) 


615
616
617
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 615

def destination_type
  @destination_type
end

#electronic_benefits_transfer ⇒ ElectronicBenefitsTransfer

Contains card verification control flags for transaction-level verification settings.

Returns:



308
309
310
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 308

def electronic_benefits_transfer
  @electronic_benefits_transfer
end

#enable_escrow_option ⇒ TrueClass | FalseClass

Indicates whether to use the customer’s escrow agreement. Possible values:

  • true: yes, use the customer’s escrow agreement.
  • false: no, do not use the customer’s escrow agreement.

Returns:

  • (TrueClass | FalseClass) 


42
43
44
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 42

def enable_escrow_option
  @enable_escrow_option
end

#enabler_id ⇒ String

Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers.

Returns:

  • (String) 


516
517
518
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 516

def enabler_id
  @enabler_id
end

#extended_credit_total_count ⇒ String

A private national-use field submitted by acquirers and issuers in South Africa for South Africa-domestic (intra-country) authorizations and financial requests. Values for this field are 00 through 99.

Returns:

  • (String) 


436
437
438
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 436

def extended_credit_total_count
  @extended_credit_total_count
end

#industry_data_type ⇒ String

Indicates that the transaction includes industry-specific data. Possible Values:

  • airline
  • restaurant
  • lodging
  • auto_rental
  • transit
  • healthcare_medical
  • healthcare_transit
  • transit

Card Present, Airlines and Auto Rental

You must set this field to airline in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, no airline data is sent to the processor. You must set this field to restaurant in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, no restaurant data is sent to the processor. You must set this field to auto_rental in order for auto rental data to be sent to the processor. For example, if this field is not set to auto_rental or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet.

Returns:

  • (String) 


251
252
253
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 251

def industry_data_type
  @industry_data_type
end

#inquiry_type ⇒ String

Type of inquiry for Zero dollar transactions. Mastercard is introducing Mastercard One Credential, a single, digitally connected credential that offers cardholders the ability to access multiple payment methods. This field is used for Product Status Inquiry (PSI), Account Status Inquiry with Product Status Inquiry (ASI with PSI), and Account Status Inquiry with Product Status Inquiry and Probability Indicator. This field is supported for Zero dollar transactions only. Possible values:

  • 01: Product status inquiry
  • 02: Account status inquiry with product status inquiry
  • 03: Account status Inquiry with Product Status Inquiry and Probability Indicator

Used by

Authorization (Zero dollar transactions) Optional field.

Returns:

  • (String) 


637
638
639
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 637

def inquiry_type
  @inquiry_type
end

#intents_id ⇒ String

Set to the value of the requestID field returned in the order service response.

Returns:

  • (String) 


213
214
215
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 213

def intents_id
  @intents_id
end

#is_return_auth_record_enabled ⇒ TrueClass | FalseClass

Flag that indicates the functionality we are having for merchants for which auth is done through Cybersource but settlement is done by themselves. true: functionality is supported. Processor should send raw processor auth response to Merchant. false: functionality is not supported. Default: false

Returns:

  • (TrueClass | FalseClass) 


495
496
497
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 495

def is_return_auth_record_enabled
  @is_return_auth_record_enabled
end

#japan_payment_options ⇒ JapanPaymentOptions

The override value of the Merchant Verification Value (MVV) received by various card brands. MVV refers to the value assigned by the card brand/network to identify participation in select merchant programs. Sample value for Visa: 101010

Returns:



400
401
402
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 400

def japan_payment_options
  @japan_payment_options
end

#language_code ⇒ String

Contains the ISO 639-2 defined language Code

Returns:

  • (String) 


569
570
571
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 569

def language_code
  @language_code
end

#link_id ⇒ String

Value that links the current authorization request to the original authorization request or previous declined Merchant Initiated Debt Recovery Transactions . Set this value to the ID that was returned in the reply message from the original authorization request or previous declined Merchant Initiated Debt Recovery Transactions. This value is used for:

  • Partial authorizations
  • Split shipments
  • Merchant Initiated Debt Recovery Transactions for Visa Platform Connect and China Union Pay merchants

Returns:

  • (String) 


196
197
198
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 196

def link_id
  @link_id
end

#loan_options ⇒ LoanOptions

Contains card verification control flags for transaction-level verification settings.

Returns:



313
314
315
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 313

def loan_options
  @loan_options
end

#merchant_verification_value ⇒ String

The override value of the Merchant Verification Value (MVV) received by various card brands. MVV refers to the value assigned by the card brand/network to identify participation in select merchant programs. Sample value for Visa: 101010

Returns:

  • (String) 


393
394
395
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 393

def merchant_verification_value
  @merchant_verification_value
end

#mobile_remote_payment_type ⇒ String

Type of payment initiated from a cardholder's mobile device. Possible values:

  • 1 : Consumer-initiated remote purchase, face-to-face
  • 2 : Consumer-initiated remote purchase, e-commerce
  • 3 : Consumer-initiated remote purchase, mail order / telephone order
  • 4 : Consumer-initiated bill pay
  • 5 : Consumer-initiated top up
  • 6 : Consumer-initiated cash out
  • 7 : ATM triggered or agent-initiated cash out
  • 8 : Merchant-initiated remote purchase, face-to-face
  • 9 : Merchant-initiated remote purchase, e-commerce This field is supported only for Mastercard transactions on CyberSource through VisaNet. Optional field. Note On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file:
  • Record: CP01 TCR6
  • Position: 94
  • Field: Mastercard Mobile Remote Payment Program Indicator The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks.

Returns:

  • (String) 


429
430
431
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 429

def mobile_remote_payment_type
  @mobile_remote_payment_type
end

#national_net_domestic_data ⇒ String

Supplementary domestic transaction information provided by the acquirer for National Net Settlement Service (NNSS) transactions. NNSS is a settlement service that Visa provides. For transactions on CyberSource through VisaNet in countries that subscribe to NNSS: VisaNet clears transactions; VisaNet transfers funds to the acquirer after deducting processing fees and interchange fees. VisaNet settles transactions in the local pricing currency through a local financial institution. This field is supported only on CyberSource through VisaNet for domestic data in Colombia

Returns:

  • (String) 


386
387
388
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 386

def national_net_domestic_data
  @national_net_domestic_data
end

#network_partner_id ⇒ String

Merchant payment gateway ID that is assigned by Mastercard and is provided by the acquirer when a registered merchant payment gateway service provider is involved in the transaction. This field is supported for Visa Platform Connect, Chase Paymentech Salem.

Returns:

  • (String) 


502
503
504
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 502

def network_partner_id
  @network_partner_id
end

#network_routing_order ⇒ String

On PIN Debit Gateways: This U.S.-only field is optionally used by participants (merchants and acquirers) to specify the network access priority. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the sharing group code. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer’s preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer’s routing priorities.

PIN debit

Priority order of the networks through which he transaction will be routed. Set this value to a series of one-character network codes in your preferred order. This is a list of the network codes:

Network Code
Accel E
AFFN U
Alaska Option 3
CU24 C
Interlink G
Maestro 8
NETS P
NYCE F
Pulse H
Shazam 7
Star M
Visa V

For example, if the Star network is your first preference and Pulse is your second preference, set this field to a value of MH. When you do not include this value in your PIN debit request, the list of network codes from your account is used. Note This field is supported only for businesses located in the U.S. Optional field for PIN debit credit or PIN debit purchase.

Returns:

  • (String) 


473
474
475
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 473

def network_routing_order
  @network_routing_order
end

#original_payment_id ⇒ String

This value is used for linking Authorization extension transaction to the original Authorization transaction and for linking MIT (Merchant initiated transaction) with the respective CIT (Customer initiated transaction).

Returns:

  • (String) 


576
577
578
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 576

def original_payment_id
  @original_payment_id
end

#pay_by_points_indicator ⇒ TrueClass | FalseClass

Flag that indicates if the transaction is pay by points transaction true: Transaction uses loyalty points false: Transaction does not use loyalty points Default: false

Returns:

  • (TrueClass | FalseClass) 


480
481
482
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 480

def pay_by_points_indicator
  @pay_by_points_indicator
end

#payment_solution ⇒ String

Type of digital payment solution for the transaction. Possible Values:

  • visacheckout: Visa Checkout. This value is required for Visa Checkout transactions. For details, see payment_solution field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifie lds/reference/all/rest/api-fields.pdf)
  • 001: Apple Pay.
  • 004: Cybersource In-App Solution.
  • 005: Masterpass. This value is required for Masterpass transactions on OmniPay Direct.
  • 006: Android Pay.
  • 007: Chase Pay.
  • 008: Samsung Pay.
  • 012: Google Pay.
  • 013: Cybersource P2PE Decryption
  • 014: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.
  • 015: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token.
  • 027: Click to Pay.

Returns:

  • (String) 


175
176
177
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 175

def payment_solution
  @payment_solution
end

#payment_type ⇒ String

Identifier for the payment type.

Returns:

  • (String) 


506
507
508
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 506

def payment_type
  @payment_type
end

#processing_instruction ⇒ String

The instruction to process an order.

  • default value: 'NO_INSTRUCTION'
  • 'ORDER_SAVED_EXPLICITLY'

Returns:

  • (String) 


522
523
524
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 522

def processing_instruction
  @processing_instruction
end

#processor_id ⇒ String

Value that identifies the processor/acquirer to use for the transaction. This value is supported only for CyberSource through VisaNet. Contact CyberSource Customer Support to get the value for this field.

Returns:

  • (String) 


79
80
81
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 79

def processor_id
  @processor_id
end

#program_indicators ⇒ ProgramIndicators

Contains program-specific indicators for transaction processing.

Returns:



619
620
621
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 619

def program_indicators
  @program_indicators
end

#purchase_level ⇒ String

Set this field to 3 to indicate that the request includes Level III data.

Returns:

  • (String) 


200
201
202
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 200

def purchase_level
  @purchase_level
end

#purchase_options ⇒ PurchaseOptions

Contains card verification control flags for transaction-level verification settings.

Returns:



303
304
305
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 303

def purchase_options
  @purchase_options
end

#purpose_of_payment ⇒ String

This field is applicable for AFT and OCT transactions. For list of supported values, please refer to Developer Guide.

Returns:

  • (String) 


565
566
567
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 565

def purpose_of_payment
  @purpose_of_payment
end

#reconciliation_id ⇒ String

Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request.

  • For Payouts: max length for FDCCompass is String (22).

Returns:

  • (String) 


182
183
184
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 182

def reconciliation_id
  @reconciliation_id
end

#recurring_options ⇒ RecurringOptions

Contains card verification control flags for transaction-level verification settings.

Returns:



293
294
295
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 293

def recurring_options
  @recurring_options
end

#report_group ⇒ String

Attribute that lets you define custom grouping for your processor reports. This field is supported only for Worldpay VAP.

Returns:

  • (String) 


218
219
220
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 218

def report_group
  @report_group
end

#timeout ⇒ Integer

Minutes until a pending MyBank transaction will be timed out. Value must be between 5 and 30. Default is 5.

Returns:

  • (Integer) 


485
486
487
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 485

def timeout
  @timeout
end

#transaction_timeout ⇒ Integer

The time-out limit in seconds for the transaction. The time-out limit starts when the customer is directed to the merchant URL that is included in the sale service response. The maximum value is 99999 (about 27 hours). When the transaction times out, the payment system changes the status to abandoned.

Returns:

  • (Integer) 


208
209
210
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 208

def transaction_timeout
  @transaction_timeout
end

#transaction_type_indicator ⇒ String

This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only. Possible values:

  • 201- Mastercard Rebate
  • 202- rePower Load Value
  • 203- Gaming Re-pay
  • 204- General Person-to-Person
  • 205- General Transfer to Own Account
  • 206- Agent Cash Out
  • 207- Payment of Own Credit Card Bill
  • 208- Business Disbursement
  • 209- Government/Non-Profit Disbursement
  • 210- Rapid Merchant Settlement
  • 211- Cash in at ATM (Usage limited to specific countries)
  • 212- Cash in at Point of Sale (Usage limited to specific countries)
  • 213- General Business to Business Transfer
  • 214- Mastercard Merchant Presented QR
  • 215- Mastercard Merchant Presented QR Refund Payment
  • 216- Utility Payments (for Brazil domestic use only)
  • 217- Government Services (for Brazil domestic use only)
  • 218- Mobile phone top-ups (for Brazil domestic use only)
  • 219- Coupon booklet payments (for Brazil domestic use only)
  • 220- General Person-to-Person Transfer
  • 221- Person-to-Person Transfer to Card Account
  • 222- General Transfer to Own Account
  • 223- Agent Cash Out
  • 224- Payment of Own Credit Card Bill
  • 225- Business Disbursement
  • 226- Transfer to Own Staged Digital Wallet Account
  • 227- Transfer to Own Debit or Prepaid Account
  • 228- General Business-to-Business Transfer
  • 229- Installment-based repayment
  • 230- Mastercard ATM Cash Pick-Up Transaction
  • 231- Cryptocurrency
  • 232- High-risk Securities

Returns:

  • (String) 


560
561
562
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 560

def transaction_type_indicator
  @transaction_type_indicator
end

#visa_checkout_id ⇒ String

Identifier for the Visa Checkout order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout callID field.

Returns:

  • (String) 


224
225
226
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 224

def visa_checkout_id
  @visa_checkout_id
end

#wallet_transaction_intent ⇒ Float

Identifies the type of operation being performed by the staged digital wallet operator. The value distinguishes between a Cash-in transaction (coded as “02”), where funds are loaded into the digital wallet from a registered payment card, and a Purchase transaction (coded as “01”), where the wallet is used to make a payment to a merchant or transfer funds between wallets. This distinction is essential for transaction processing, reporting, and ensuring compliance with the specific rules and requirements associated with each card brand and transaction type.

Returns:

  • (Float) 


606
607
608
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 606

def wallet_transaction_intent
  @wallet_transaction_intent
end

#wallet_type ⇒ String

This field carries the wallet type in authorization requests and credit requests. Possible value are:

  • 101: Masterpass remote payment. The customer created the wallet by manually interacting with a customer-controlled device such as a computer, tablet, or phone. This value is supported only for Masterpass transactions on Chase Paymentech Solutions and CyberSource through VisaNet.
  • 102: Masterpass remote near field communication (NFC) payment. The customer created the wallet by tapping a PayPass card or customer-controlled device at a contactless card reader. This value is supported only for card-present Masterpass transactions on CyberSource through VisaNet.
  • 103: Masterpass Apple Pay payment. The payment was made with a combination of Masterpass and Apple Pay. This value is supported only for Masterpass Apple Pay transactions on CyberSource through VisaNet.
  • 216: Masterpass Google Pay payment. The payment was made with a combination of Masterpass and Google Pay. This value is supported only for Masterpass Google Pay transactions on CyberSource through VisaNet.
  • 217: Masterpass Samsung Pay payment. The payment was made with a combination of Masterpass and Samsung Pay. This value is supported only for Masterpass Samsung Pay transactions on CyberSource through VisaNet.
  • SDW: Staged digital wallet. An issuer or operator created the wallet. This value is supported only for Masterpass transactions on Chase Paymentech Solutions.
  • VCIND: Visa Checkout payment. This value is supported only on CyberSource through VisaNet, FDC Compass, FDC Nashville Global, FDI Australia, and TSYS Acquiring Solutions. See Getting Started with Visa Checkout. For Visa Checkout transactions, the way CyberSource processes the value for this field depends on the processor. See the Visa Checkout section below. For all other values, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor. Masterpass (101, 102, 103, 216, and 217): The Masterpass platform generates the wallet type value and passes it to you along with the customer’s checkout information. Visa Checkout: This field is optional for Visa Checkout authorizations on FDI Australia. For all other processors, this field is required for Visa Checkout authorizations. For Visa Checkout transactions on the following processors, CyberSource sends the value that the processor expects for this field:FDC Compass,FDC Nashville Global,FDI Australia,TSYS Acquiring Solutions For all other processors, this field is a passthrough; therefore, CyberSource does not verify the value or modify it in any way before sending it to the processor. For incremental authorizations, this field is supported only for Mastercard and the supported values are 101 and 102. Payment card companies can introduce new values without notice. Your order management system should be able to process new values without problems. CyberSource through VisaNet When the value for this field is 101, 102, 103, 216, or 217, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR6, Position: 88-90, Field: Mastercard Wallet Identifier. When the value for this field is VCIND, it corresponds to the following data in the TC 33 capture file5: Record: CP01 TCR8, Position: 72-76, Field: Agent Unique ID.

Returns:

  • (String) 


372
373
374
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 372

def wallet_type
  @wallet_type
end

Class Method Details

.from_element(root) ⇒ Object 



1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 1011

def self.from_element(root)
  action_list = XmlUtilities.from_element_to_array(root, 'actionList',
                                                   String)
  enable_escrow_option = XmlUtilities.from_element(root,
                                                   'enableEscrowOption',
                                                   TrueClass)
  action_token_types = XmlUtilities.from_element_to_array(
    root, 'actionTokenTypes', String
  )
  bin_source = XmlUtilities.from_element(root, 'binSource', String)
  capture = XmlUtilities.from_element(root, 'capture', TrueClass)
  processor_id = XmlUtilities.from_element(root, 'processorId', String)
  business_application_id = XmlUtilities.from_element(
    root, 'businessApplicationId', String
  )
  commerce_indicator = XmlUtilities.from_element(root, 'commerceIndicator',
                                                 String)
  commerce_indicator_label = XmlUtilities.from_element(
    root, 'commerceIndicatorLabel', String
  )
  payment_solution = XmlUtilities.from_element(root, 'paymentSolution',
                                               String)
  reconciliation_id = XmlUtilities.from_element(root, 'reconciliationId',
                                                String)
  link_id = XmlUtilities.from_element(root, 'linkId', String)
  purchase_level = XmlUtilities.from_element(root, 'purchaseLevel', String)
  transaction_timeout = XmlUtilities.from_element(root,
                                                  'transactionTimeout',
                                                  Integer)
  intents_id = XmlUtilities.from_element(root, 'intentsId', String)
  report_group = XmlUtilities.from_element(root, 'reportGroup', String)
  visa_checkout_id = XmlUtilities.from_element(root, 'visaCheckoutId',
                                               String)
  industry_data_type = XmlUtilities.from_element(root, 'industryDataType',
                                                 String)
  authorization_options = XmlUtilities.from_element(
    root, 'processingInfoAuthorizationOptions',
    ProcessingInfOauthOrizationOptions
  )
  card_verification = XmlUtilities.from_element(root, 'CardVerification',
                                                CardVerification)
  capture_options = XmlUtilities.from_element(root, 'CaptureOptions',
                                              CaptureOptions)
  recurring_options = XmlUtilities.from_element(root, 'RecurringOptions',
                                                RecurringOptions)
  bank_transfer_options = XmlUtilities.from_element(root,
                                                    'BankTransferOptions',
                                                    BankTransferOptions)
  purchase_options = XmlUtilities.from_element(root, 'PurchaseOptions',
                                               PurchaseOptions)
  electronic_benefits_transfer = XmlUtilities.from_element(
    root, 'ElectronicBenefitsTransfer',
    ElectronicBenefitsTransfer
  )
  loan_options = XmlUtilities.from_element(root, 'LoanOptions', LoanOptions)
  wallet_type = XmlUtilities.from_element(root, 'walletType', String)
  national_net_domestic_data = XmlUtilities.from_element(
    root, 'nationalNetDomesticData', String
  )
  merchant_verification_value = XmlUtilities.from_element(
    root, 'merchantVerificationValue', String
  )
  japan_payment_options = XmlUtilities.from_element(root,
                                                    'JapanPaymentOptions',
                                                    JapanPaymentOptions)
  mobile_remote_payment_type = XmlUtilities.from_element(
    root, 'mobileRemotePaymentType', String
  )
  extended_credit_total_count = XmlUtilities.from_element(
    root, 'extendedCreditTotalCount', String
  )
  network_routing_order = XmlUtilities.from_element(root,
                                                    'networkRoutingOrder',
                                                    String)
  pay_by_points_indicator = XmlUtilities.from_element(
    root, 'payByPointsIndicator', TrueClass
  )
  timeout = XmlUtilities.from_element(root, 'timeout', Integer)
  is_return_auth_record_enabled = XmlUtilities.from_element(
    root, 'isReturnAuthRecordEnabled', TrueClass
  )
  network_partner_id = XmlUtilities.from_element(root, 'networkPartnerId',
                                                 String)
  payment_type = XmlUtilities.from_element(root, 'paymentType', String)
  enabler_id = XmlUtilities.from_element(root, 'enablerId', String)
  processing_instruction = XmlUtilities.from_element(
    root, 'processingInstruction', String
  )
  transaction_type_indicator = XmlUtilities.from_element(
    root, 'transactionTypeIndicator', String
  )
  purpose_of_payment = XmlUtilities.from_element(root, 'purposeOfPayment',
                                                 String)
  language_code = XmlUtilities.from_element(root, 'languageCode', String)
  original_payment_id = XmlUtilities.from_element(root, 'originalPaymentId',
                                                  String)
  amex_indirect_model_type = XmlUtilities.from_element(
    root, 'amexIndirectModelType', String
  )
  wallet_transaction_intent = XmlUtilities.from_element(
    root, 'walletTransactionIntent', Float
  )
  destination_type = XmlUtilities.from_element(root, 'destinationType',
                                               Float)
  program_indicators = XmlUtilities.from_element(root, 'ProgramIndicators',
                                                 ProgramIndicators)
  inquiry_type = XmlUtilities.from_element(root, 'inquiryType', String)

  new(action_list: action_list,
      enable_escrow_option: enable_escrow_option,
      action_token_types: action_token_types,
      bin_source: bin_source,
      capture: capture,
      processor_id: processor_id,
      business_application_id: business_application_id,
      commerce_indicator: commerce_indicator,
      commerce_indicator_label: commerce_indicator_label,
      payment_solution: payment_solution,
      reconciliation_id: reconciliation_id,
      link_id: link_id,
      purchase_level: purchase_level,
      transaction_timeout: transaction_timeout,
      intents_id: intents_id,
      report_group: report_group,
      visa_checkout_id: visa_checkout_id,
      industry_data_type: industry_data_type,
      authorization_options: authorization_options,
      card_verification: card_verification,
      capture_options: capture_options,
      recurring_options: recurring_options,
      bank_transfer_options: bank_transfer_options,
      purchase_options: purchase_options,
      electronic_benefits_transfer: electronic_benefits_transfer,
      loan_options: loan_options,
      wallet_type: wallet_type,
      national_net_domestic_data: national_net_domestic_data,
      merchant_verification_value: merchant_verification_value,
      japan_payment_options: japan_payment_options,
      mobile_remote_payment_type: mobile_remote_payment_type,
      extended_credit_total_count: extended_credit_total_count,
      network_routing_order: network_routing_order,
      pay_by_points_indicator: pay_by_points_indicator,
      timeout: timeout,
      is_return_auth_record_enabled: is_return_auth_record_enabled,
      network_partner_id: network_partner_id,
      payment_type: payment_type,
      enabler_id: enabler_id,
      processing_instruction: processing_instruction,
      transaction_type_indicator: transaction_type_indicator,
      purpose_of_payment: purpose_of_payment,
      language_code: language_code,
      original_payment_id: original_payment_id,
      amex_indirect_model_type: amex_indirect_model_type,
      wallet_transaction_intent: wallet_transaction_intent,
      destination_type: destination_type,
      program_indicators: program_indicators,
      inquiry_type: inquiry_type,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 862

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  action_list = hash.key?('actionList') ? hash['actionList'] : SKIP
  enable_escrow_option =
    hash.key?('enableEscrowOption') ? hash['enableEscrowOption'] : SKIP
  action_token_types =
    hash.key?('actionTokenTypes') ? hash['actionTokenTypes'] : SKIP
  bin_source = hash.key?('binSource') ? hash['binSource'] : SKIP
  capture = hash['capture'] ||= false
  processor_id = hash.key?('processorId') ? hash['processorId'] : SKIP
  business_application_id =
    hash.key?('businessApplicationId') ? hash['businessApplicationId'] : SKIP
  commerce_indicator =
    hash.key?('commerceIndicator') ? hash['commerceIndicator'] : SKIP
  commerce_indicator_label =
    hash.key?('commerceIndicatorLabel') ? hash['commerceIndicatorLabel'] : SKIP
  payment_solution =
    hash.key?('paymentSolution') ? hash['paymentSolution'] : SKIP
  reconciliation_id =
    hash.key?('reconciliationId') ? hash['reconciliationId'] : SKIP
  link_id = hash.key?('linkId') ? hash['linkId'] : SKIP
  purchase_level = hash.key?('purchaseLevel') ? hash['purchaseLevel'] : SKIP
  transaction_timeout =
    hash.key?('transactionTimeout') ? hash['transactionTimeout'] : SKIP
  intents_id = hash.key?('intentsId') ? hash['intentsId'] : SKIP
  report_group = hash.key?('reportGroup') ? hash['reportGroup'] : SKIP
  visa_checkout_id =
    hash.key?('visaCheckoutId') ? hash['visaCheckoutId'] : SKIP
  industry_data_type =
    hash.key?('industryDataType') ? hash['industryDataType'] : SKIP
  if hash['authorizationOptions']
    authorization_options = ProcessingInfOauthOrizationOptions.from_hash(hash['authorizationOptions'])
  end
  card_verification = CardVerification.from_hash(hash['cardVerification']) if
    hash['cardVerification']
  capture_options = CaptureOptions.from_hash(hash['captureOptions']) if hash['captureOptions']
  recurring_options = RecurringOptions.from_hash(hash['recurringOptions']) if
    hash['recurringOptions']
  bank_transfer_options = BankTransferOptions.from_hash(hash['bankTransferOptions']) if
    hash['bankTransferOptions']
  purchase_options = PurchaseOptions.from_hash(hash['purchaseOptions']) if
    hash['purchaseOptions']
  if hash['electronicBenefitsTransfer']
    electronic_benefits_transfer = ElectronicBenefitsTransfer.from_hash(hash['electronicBenefitsTransfer'])
  end
  loan_options = LoanOptions.from_hash(hash['loanOptions']) if hash['loanOptions']
  wallet_type = hash.key?('walletType') ? hash['walletType'] : SKIP
  national_net_domestic_data =
    hash.key?('nationalNetDomesticData') ? hash['nationalNetDomesticData'] : SKIP
  merchant_verification_value =
    hash.key?('merchantVerificationValue') ? hash['merchantVerificationValue'] : SKIP
  japan_payment_options = JapanPaymentOptions.from_hash(hash['japanPaymentOptions']) if
    hash['japanPaymentOptions']
  mobile_remote_payment_type =
    hash.key?('mobileRemotePaymentType') ? hash['mobileRemotePaymentType'] : SKIP
  extended_credit_total_count =
    hash.key?('extendedCreditTotalCount') ? hash['extendedCreditTotalCount'] : SKIP
  network_routing_order =
    hash.key?('networkRoutingOrder') ? hash['networkRoutingOrder'] : SKIP
  pay_by_points_indicator =
    hash.key?('payByPointsIndicator') ? hash['payByPointsIndicator'] : SKIP
  timeout = hash.key?('timeout') ? hash['timeout'] : SKIP
  is_return_auth_record_enabled =
    hash.key?('isReturnAuthRecordEnabled') ? hash['isReturnAuthRecordEnabled'] : SKIP
  network_partner_id =
    hash.key?('networkPartnerId') ? hash['networkPartnerId'] : SKIP
  payment_type = hash.key?('paymentType') ? hash['paymentType'] : SKIP
  enabler_id = hash.key?('enablerId') ? hash['enablerId'] : SKIP
  processing_instruction =
    hash.key?('processingInstruction') ? hash['processingInstruction'] : SKIP
  transaction_type_indicator =
    hash.key?('transactionTypeIndicator') ? hash['transactionTypeIndicator'] : SKIP
  purpose_of_payment =
    hash.key?('purposeOfPayment') ? hash['purposeOfPayment'] : SKIP
  language_code = hash.key?('languageCode') ? hash['languageCode'] : SKIP
  original_payment_id =
    hash.key?('originalPaymentId') ? hash['originalPaymentId'] : SKIP
  amex_indirect_model_type =
    hash.key?('amexIndirectModelType') ? hash['amexIndirectModelType'] : SKIP
  wallet_transaction_intent =
    hash.key?('walletTransactionIntent') ? hash['walletTransactionIntent'] : SKIP
  destination_type =
    hash.key?('destinationType') ? hash['destinationType'] : SKIP
  program_indicators = ProgramIndicators.from_hash(hash['programIndicators']) if
    hash['programIndicators']
  inquiry_type = hash.key?('inquiryType') ? hash['inquiryType'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  ProcessingInformation.new(action_list: action_list,
                            enable_escrow_option: enable_escrow_option,
                            action_token_types: action_token_types,
                            bin_source: bin_source,
                            capture: capture,
                            processor_id: processor_id,
                            business_application_id: business_application_id,
                            commerce_indicator: commerce_indicator,
                            commerce_indicator_label: commerce_indicator_label,
                            payment_solution: payment_solution,
                            reconciliation_id: reconciliation_id,
                            link_id: link_id,
                            purchase_level: purchase_level,
                            transaction_timeout: transaction_timeout,
                            intents_id: intents_id,
                            report_group: report_group,
                            visa_checkout_id: visa_checkout_id,
                            industry_data_type: industry_data_type,
                            authorization_options: authorization_options,
                            card_verification: card_verification,
                            capture_options: capture_options,
                            recurring_options: recurring_options,
                            bank_transfer_options: bank_transfer_options,
                            purchase_options: purchase_options,
                            electronic_benefits_transfer: electronic_benefits_transfer,
                            loan_options: loan_options,
                            wallet_type: wallet_type,
                            national_net_domestic_data: national_net_domestic_data,
                            merchant_verification_value: merchant_verification_value,
                            japan_payment_options: japan_payment_options,
                            mobile_remote_payment_type: mobile_remote_payment_type,
                            extended_credit_total_count: extended_credit_total_count,
                            network_routing_order: network_routing_order,
                            pay_by_points_indicator: pay_by_points_indicator,
                            timeout: timeout,
                            is_return_auth_record_enabled: is_return_auth_record_enabled,
                            network_partner_id: network_partner_id,
                            payment_type: payment_type,
                            enabler_id: enabler_id,
                            processing_instruction: processing_instruction,
                            transaction_type_indicator: transaction_type_indicator,
                            purpose_of_payment: purpose_of_payment,
                            language_code: language_code,
                            original_payment_id: original_payment_id,
                            amex_indirect_model_type: amex_indirect_model_type,
                            wallet_transaction_intent: wallet_transaction_intent,
                            destination_type: destination_type,
                            program_indicators: program_indicators,
                            inquiry_type: inquiry_type,
                            additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 640

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['action_list'] = 'actionList'
  @_hash['enable_escrow_option'] = 'enableEscrowOption'
  @_hash['action_token_types'] = 'actionTokenTypes'
  @_hash['bin_source'] = 'binSource'
  @_hash['capture'] = 'capture'
  @_hash['processor_id'] = 'processorId'
  @_hash['business_application_id'] = 'businessApplicationId'
  @_hash['commerce_indicator'] = 'commerceIndicator'
  @_hash['commerce_indicator_label'] = 'commerceIndicatorLabel'
  @_hash['payment_solution'] = 'paymentSolution'
  @_hash['reconciliation_id'] = 'reconciliationId'
  @_hash['link_id'] = 'linkId'
  @_hash['purchase_level'] = 'purchaseLevel'
  @_hash['transaction_timeout'] = 'transactionTimeout'
  @_hash['intents_id'] = 'intentsId'
  @_hash['report_group'] = 'reportGroup'
  @_hash['visa_checkout_id'] = 'visaCheckoutId'
  @_hash['industry_data_type'] = 'industryDataType'
  @_hash['authorization_options'] = 'authorizationOptions'
  @_hash['card_verification'] = 'cardVerification'
  @_hash['capture_options'] = 'captureOptions'
  @_hash['recurring_options'] = 'recurringOptions'
  @_hash['bank_transfer_options'] = 'bankTransferOptions'
  @_hash['purchase_options'] = 'purchaseOptions'
  @_hash['electronic_benefits_transfer'] = 'electronicBenefitsTransfer'
  @_hash['loan_options'] = 'loanOptions'
  @_hash['wallet_type'] = 'walletType'
  @_hash['national_net_domestic_data'] = 'nationalNetDomesticData'
  @_hash['merchant_verification_value'] = 'merchantVerificationValue'
  @_hash['japan_payment_options'] = 'japanPaymentOptions'
  @_hash['mobile_remote_payment_type'] = 'mobileRemotePaymentType'
  @_hash['extended_credit_total_count'] = 'extendedCreditTotalCount'
  @_hash['network_routing_order'] = 'networkRoutingOrder'
  @_hash['pay_by_points_indicator'] = 'payByPointsIndicator'
  @_hash['timeout'] = 'timeout'
  @_hash['is_return_auth_record_enabled'] = 'isReturnAuthRecordEnabled'
  @_hash['network_partner_id'] = 'networkPartnerId'
  @_hash['payment_type'] = 'paymentType'
  @_hash['enabler_id'] = 'enablerId'
  @_hash['processing_instruction'] = 'processingInstruction'
  @_hash['transaction_type_indicator'] = 'transactionTypeIndicator'
  @_hash['purpose_of_payment'] = 'purposeOfPayment'
  @_hash['language_code'] = 'languageCode'
  @_hash['original_payment_id'] = 'originalPaymentId'
  @_hash['amex_indirect_model_type'] = 'amexIndirectModelType'
  @_hash['wallet_transaction_intent'] = 'walletTransactionIntent'
  @_hash['destination_type'] = 'destinationType'
  @_hash['program_indicators'] = 'programIndicators'
  @_hash['inquiry_type'] = 'inquiryType'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



750
751
752
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 750

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 695

def self.optionals
  %w[
    action_list
    enable_escrow_option
    action_token_types
    bin_source
    capture
    processor_id
    business_application_id
    commerce_indicator
    commerce_indicator_label
    payment_solution
    reconciliation_id
    link_id
    purchase_level
    transaction_timeout
    intents_id
    report_group
    visa_checkout_id
    industry_data_type
    authorization_options
    card_verification
    capture_options
    recurring_options
    bank_transfer_options
    purchase_options
    electronic_benefits_transfer
    loan_options
    wallet_type
    national_net_domestic_data
    merchant_verification_value
    japan_payment_options
    mobile_remote_payment_type
    extended_credit_total_count
    network_routing_order
    pay_by_points_indicator
    timeout
    is_return_auth_record_enabled
    network_partner_id
    payment_type
    enabler_id
    processing_instruction
    transaction_type_indicator
    purpose_of_payment
    language_code
    original_payment_id
    amex_indirect_model_type
    wallet_transaction_intent
    destination_type
    program_indicators
    inquiry_type
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 1297

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} action_list: #{@action_list.inspect}, enable_escrow_option:"\
  " #{@enable_escrow_option.inspect}, action_token_types: #{@action_token_types.inspect},"\
  " bin_source: #{@bin_source.inspect}, capture: #{@capture.inspect}, processor_id:"\
  " #{@processor_id.inspect}, business_application_id: #{@business_application_id.inspect},"\
  " commerce_indicator: #{@commerce_indicator.inspect}, commerce_indicator_label:"\
  " #{@commerce_indicator_label.inspect}, payment_solution: #{@payment_solution.inspect},"\
  " reconciliation_id: #{@reconciliation_id.inspect}, link_id: #{@link_id.inspect},"\
  " purchase_level: #{@purchase_level.inspect}, transaction_timeout:"\
  " #{@transaction_timeout.inspect}, intents_id: #{@intents_id.inspect}, report_group:"\
  " #{@report_group.inspect}, visa_checkout_id: #{@visa_checkout_id.inspect},"\
  " industry_data_type: #{@industry_data_type.inspect}, authorization_options:"\
  " #{@authorization_options.inspect}, card_verification: #{@card_verification.inspect},"\
  " capture_options: #{@capture_options.inspect}, recurring_options:"\
  " #{@recurring_options.inspect}, bank_transfer_options: #{@bank_transfer_options.inspect},"\
  " purchase_options: #{@purchase_options.inspect}, electronic_benefits_transfer:"\
  " #{@electronic_benefits_transfer.inspect}, loan_options: #{@loan_options.inspect},"\
  " wallet_type: #{@wallet_type.inspect}, national_net_domestic_data:"\
  " #{@national_net_domestic_data.inspect}, merchant_verification_value:"\
  " #{@merchant_verification_value.inspect}, japan_payment_options:"\
  " #{@japan_payment_options.inspect}, mobile_remote_payment_type:"\
  " #{@mobile_remote_payment_type.inspect}, extended_credit_total_count:"\
  " #{@extended_credit_total_count.inspect}, network_routing_order:"\
  " #{@network_routing_order.inspect}, pay_by_points_indicator:"\
  " #{@pay_by_points_indicator.inspect}, timeout: #{@timeout.inspect},"\
  " is_return_auth_record_enabled: #{@is_return_auth_record_enabled.inspect},"\
  " network_partner_id: #{@network_partner_id.inspect}, payment_type:"\
  " #{@payment_type.inspect}, enabler_id: #{@enabler_id.inspect}, processing_instruction:"\
  " #{@processing_instruction.inspect}, transaction_type_indicator:"\
  " #{@transaction_type_indicator.inspect}, purpose_of_payment:"\
  " #{@purpose_of_payment.inspect}, language_code: #{@language_code.inspect},"\
  " original_payment_id: #{@original_payment_id.inspect}, amex_indirect_model_type:"\
  " #{@amex_indirect_model_type.inspect}, wallet_transaction_intent:"\
  " #{@wallet_transaction_intent.inspect}, destination_type: #{@destination_type.inspect},"\
  " program_indicators: #{@program_indicators.inspect}, inquiry_type:"\
  " #{@inquiry_type.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 1265

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} action_list: #{@action_list}, enable_escrow_option:"\
  " #{@enable_escrow_option}, action_token_types: #{@action_token_types}, bin_source:"\
  " #{@bin_source}, capture: #{@capture}, processor_id: #{@processor_id},"\
  " business_application_id: #{@business_application_id}, commerce_indicator:"\
  " #{@commerce_indicator}, commerce_indicator_label: #{@commerce_indicator_label},"\
  " payment_solution: #{@payment_solution}, reconciliation_id: #{@reconciliation_id}, link_id:"\
  " #{@link_id}, purchase_level: #{@purchase_level}, transaction_timeout:"\
  " #{@transaction_timeout}, intents_id: #{@intents_id}, report_group: #{@report_group},"\
  " visa_checkout_id: #{@visa_checkout_id}, industry_data_type: #{@industry_data_type},"\
  " authorization_options: #{@authorization_options}, card_verification:"\
  " #{@card_verification}, capture_options: #{@capture_options}, recurring_options:"\
  " #{@recurring_options}, bank_transfer_options: #{@bank_transfer_options}, purchase_options:"\
  " #{@purchase_options}, electronic_benefits_transfer: #{@electronic_benefits_transfer},"\
  " loan_options: #{@loan_options}, wallet_type: #{@wallet_type}, national_net_domestic_data:"\
  " #{@national_net_domestic_data}, merchant_verification_value:"\
  " #{@merchant_verification_value}, japan_payment_options: #{@japan_payment_options},"\
  " mobile_remote_payment_type: #{@mobile_remote_payment_type}, extended_credit_total_count:"\
  " #{@extended_credit_total_count}, network_routing_order: #{@network_routing_order},"\
  " pay_by_points_indicator: #{@pay_by_points_indicator}, timeout: #{@timeout},"\
  " is_return_auth_record_enabled: #{@is_return_auth_record_enabled}, network_partner_id:"\
  " #{@network_partner_id}, payment_type: #{@payment_type}, enabler_id: #{@enabler_id},"\
  " processing_instruction: #{@processing_instruction}, transaction_type_indicator:"\
  " #{@transaction_type_indicator}, purpose_of_payment: #{@purpose_of_payment}, language_code:"\
  " #{@language_code}, original_payment_id: #{@original_payment_id}, amex_indirect_model_type:"\
  " #{@amex_indirect_model_type}, wallet_transaction_intent: #{@wallet_transaction_intent},"\
  " destination_type: #{@destination_type}, program_indicators: #{@program_indicators},"\
  " inquiry_type: #{@inquiry_type}, additional_properties: #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object 



1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
 
# File 'lib/cyber_source_merged_spec/models/processing_information.rb', line 1171

def to_xml_element(doc, root_name)
  root = doc.create_element(root_name)

  XmlUtilities.add_array_as_subelement(doc, root, 'actionList', action_list)
  XmlUtilities.add_as_subelement(doc, root, 'enableEscrowOption',
                                 enable_escrow_option)
  XmlUtilities.add_array_as_subelement(doc, root, 'actionTokenTypes',
                                       action_token_types)
  XmlUtilities.add_as_subelement(doc, root, 'binSource', bin_source)
  XmlUtilities.add_as_subelement(doc, root, 'capture', capture)
  XmlUtilities.add_as_subelement(doc, root, 'processorId', processor_id)
  XmlUtilities.add_as_subelement(doc, root, 'businessApplicationId',
                                 business_application_id)
  XmlUtilities.add_as_subelement(doc, root, 'commerceIndicator',
                                 commerce_indicator)
  XmlUtilities.add_as_subelement(doc, root, 'commerceIndicatorLabel',
                                 commerce_indicator_label)
  XmlUtilities.add_as_subelement(doc, root, 'paymentSolution',
                                 payment_solution)
  XmlUtilities.add_as_subelement(doc, root, 'reconciliationId',
                                 reconciliation_id)
  XmlUtilities.add_as_subelement(doc, root, 'linkId', link_id)
  XmlUtilities.add_as_subelement(doc, root, 'purchaseLevel', purchase_level)
  XmlUtilities.add_as_subelement(doc, root, 'transactionTimeout',
                                 transaction_timeout)
  XmlUtilities.add_as_subelement(doc, root, 'intentsId', intents_id)
  XmlUtilities.add_as_subelement(doc, root, 'reportGroup', report_group)
  XmlUtilities.add_as_subelement(doc, root, 'visaCheckoutId',
                                 visa_checkout_id)
  XmlUtilities.add_as_subelement(doc, root, 'industryDataType',
                                 industry_data_type)
  XmlUtilities.add_as_subelement(doc, root,
                                 'processingInfoAuthorizationOptions',
                                 authorization_options)
  XmlUtilities.add_as_subelement(doc, root, 'CardVerification',
                                 card_verification)
  XmlUtilities.add_as_subelement(doc, root, 'CaptureOptions',
                                 capture_options)
  XmlUtilities.add_as_subelement(doc, root, 'RecurringOptions',
                                 recurring_options)
  XmlUtilities.add_as_subelement(doc, root, 'BankTransferOptions',
                                 bank_transfer_options)
  XmlUtilities.add_as_subelement(doc, root, 'PurchaseOptions',
                                 purchase_options)
  XmlUtilities.add_as_subelement(doc, root, 'ElectronicBenefitsTransfer',
                                 electronic_benefits_transfer)
  XmlUtilities.add_as_subelement(doc, root, 'LoanOptions', loan_options)
  XmlUtilities.add_as_subelement(doc, root, 'walletType', wallet_type)
  XmlUtilities.add_as_subelement(doc, root, 'nationalNetDomesticData',
                                 national_net_domestic_data)
  XmlUtilities.add_as_subelement(doc, root, 'merchantVerificationValue',
                                 merchant_verification_value)
  XmlUtilities.add_as_subelement(doc, root, 'JapanPaymentOptions',
                                 japan_payment_options)
  XmlUtilities.add_as_subelement(doc, root, 'mobileRemotePaymentType',
                                 mobile_remote_payment_type)
  XmlUtilities.add_as_subelement(doc, root, 'extendedCreditTotalCount',
                                 extended_credit_total_count)
  XmlUtilities.add_as_subelement(doc, root, 'networkRoutingOrder',
                                 network_routing_order)
  XmlUtilities.add_as_subelement(doc, root, 'payByPointsIndicator',
                                 pay_by_points_indicator)
  XmlUtilities.add_as_subelement(doc, root, 'timeout', timeout)
  XmlUtilities.add_as_subelement(doc, root, 'isReturnAuthRecordEnabled',
                                 is_return_auth_record_enabled)
  XmlUtilities.add_as_subelement(doc, root, 'networkPartnerId',
                                 network_partner_id)
  XmlUtilities.add_as_subelement(doc, root, 'paymentType', payment_type)
  XmlUtilities.add_as_subelement(doc, root, 'enablerId', enabler_id)
  XmlUtilities.add_as_subelement(doc, root, 'processingInstruction',
                                 processing_instruction)
  XmlUtilities.add_as_subelement(doc, root, 'transactionTypeIndicator',
                                 transaction_type_indicator)
  XmlUtilities.add_as_subelement(doc, root, 'purposeOfPayment',
                                 purpose_of_payment)
  XmlUtilities.add_as_subelement(doc, root, 'languageCode', language_code)
  XmlUtilities.add_as_subelement(doc, root, 'originalPaymentId',
                                 original_payment_id)
  XmlUtilities.add_as_subelement(doc, root, 'amexIndirectModelType',
                                 amex_indirect_model_type)
  XmlUtilities.add_as_subelement(doc, root, 'walletTransactionIntent',
                                 wallet_transaction_intent)
  XmlUtilities.add_as_subelement(doc, root, 'destinationType',
                                 destination_type)
  XmlUtilities.add_as_subelement(doc, root, 'ProgramIndicators',
                                 program_indicators)
  XmlUtilities.add_as_subelement(doc, root, 'inquiryType', inquiry_type)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end