Class: CyberSourceMergedSpec::OriginatorInitiatedTransaction

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

Overview

OriginatorInitiatedTransaction 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(original_transaction_id: SKIP, reason: SKIP, additional_properties: nil) ⇒ OriginatorInitiatedTransaction

Returns a new instance of OriginatorInitiatedTransaction.



66
67
68
69
70
71
72
73
74
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 66

def initialize(original_transaction_id: SKIP, reason: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @original_transaction_id = original_transaction_id unless original_transaction_id == SKIP
  @reason = reason unless reason == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#original_transaction_id ⇒ String

Contains a Visa-generated Transaction Identifier (TID) that is unique for each original authorization and financial request. The identifier links original messages to subsequent messages. Conditional field. If the processingInformation.fundingOptions.initiator.type=originator, this field is mandatory. Notes:

  1. If an Pull Funds Transfer (AFT) transaction has a corresponding Push Funds Transfer (OCT) transaction, originators are strongly recommended to take the Transaction ID from the AFT and populate it into the OCT to link the two transactions together.
  2. Originators must link the Originator-Initiated Transaction with the original transaction using the Transaction Identifier that was generated for the original cardholder initiated transaction. However, for standing-instruction MITs (i.e., recurring), acquirers can use the Transaction Identifier generated for the previous transaction in the series to link the subsequent transactions.

Returns:

  • (String) 


30
31
32
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 30

def original_transaction_id
  @original_transaction_id
end

#reason ⇒ String

Possible values:

  • 1: Resubmission
  • 2: Delayed charge
  • 3: Reauthorization for split shipment
  • 4: No show
  • 5: Account top up Conditional: This field is not required for recurring transactions or when processingInformation.fundingOptions.initiator.credentialStoredOnFile = True. It is required for all other originator-initiated (MIT) transactions.

Returns:

  • (String) 


43
44
45
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 43

def reason
  @reason
end

Class Method Details

.from_element(root) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 98

def self.from_element(root)
  original_transaction_id = XmlUtilities.from_element(
    root, 'originalTransactionId', String
  )
  reason = XmlUtilities.from_element(root, 'reason', String)

  new(original_transaction_id: original_transaction_id,
      reason: reason,
      additional_properties: additional_properties)
end

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 77

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  original_transaction_id =
    hash.key?('originalTransactionId') ? hash['originalTransactionId'] : SKIP
  reason = hash.key?('reason') ? hash['reason'] : 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.
  OriginatorInitiatedTransaction.new(original_transaction_id: original_transaction_id,
                                     reason: reason,
                                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



46
47
48
49
50
51
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 46

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['original_transaction_id'] = 'originalTransactionId'
  @_hash['reason'] = 'reason'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



62
63
64
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 62

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



54
55
56
57
58
59
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 54

def self.optionals
  %w[
    original_transaction_id
    reason
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



129
130
131
132
133
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 129

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} original_transaction_id: #{@original_transaction_id.inspect}, reason:"\
  " #{@reason.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



122
123
124
125
126
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 122

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} original_transaction_id: #{@original_transaction_id}, reason: #{@reason},"\
  " additional_properties: #{@additional_properties}>"
end

#to_xml_element(doc, root_name) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/cyber_source_merged_spec/models/originator_initiated_transaction.rb', line 109

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

  XmlUtilities.add_as_subelement(doc, root, 'originalTransactionId',
                                 original_transaction_id)
  XmlUtilities.add_as_subelement(doc, root, 'reason', reason)
  XmlUtilities.add_as_subelement(doc, root, 'additional_properties',
                                 additional_properties)

  root
end