Class: CyberSource::MerchantInitiatedTransactionObject

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MerchantInitiatedTransactionObject

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 60

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'reason')
    self.reason = attributes[:'reason']
  end

  if attributes.has_key?(:'previousTransactionId')
    self.previous_transaction_id = attributes[:'previousTransactionId']
  end

  if attributes.has_key?(:'originalAuthorizedAmount')
    self.original_authorized_amount = attributes[:'originalAuthorizedAmount']
  end

  if attributes.has_key?(:'agreementId')
    self.agreement_id = attributes[:'agreementId']
  end
end

Instance Attribute Details

#agreement_id ⇒ Object

This field contains the predetermined agrement id with the merchant



26
27
28
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 26

def agreement_id
  @agreement_id
end

#original_authorized_amount ⇒ Object

Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See "Recurring Payments," and "Subsequent Authorizations," field description in the [Payment Network Tokenization Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



23
24
25
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 23

def original_authorized_amount
  @original_authorized_amount
end

#previous_transaction_id ⇒ Object

Network transaction identifier that was returned in the payment response field processorInformation.transactionID in the reply message for either the original merchant-initiated payment in the series or the previous merchant-initiated payment in the series. If the current payment request includes a token instead of an account number, the following time limits apply for the value of this field: - For a resubmission, the transaction ID must be less than 14 days old. - For a **delayed charge** or reauthorization, the transaction ID must be less than 30 days old. NOTE: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet.



20
21
22
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 20

def previous_transaction_id
  @previous_transaction_id
end

#reason ⇒ Object

Reason for the merchant-initiated transaction or incremental authorization. Possible values: - ‘1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



17
18
19
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 17

def reason
  @reason
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



29
30
31
32
33
34
35
36
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 29

def self.attribute_map
  {
    :'reason' => :'reason',
    :'previous_transaction_id' => :'previousTransactionId',
    :'original_authorized_amount' => :'originalAuthorizedAmount',
    :'agreement_id' => :'agreementId'
  }
end

.json_map ⇒ Object

Attribute mapping from JSON key to ruby-style variable name.



39
40
41
42
43
44
45
46
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 39

def self.json_map
  {
    :'reason' => :'reason',
    :'previous_transaction_id' => :'previous_transaction_id',
    :'original_authorized_amount' => :'original_authorized_amount',
    :'agreement_id' => :'agreement_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 49

def self.swagger_types
  {
    :'reason' => :'String',
    :'previous_transaction_id' => :'String',
    :'original_authorized_amount' => :'String',
    :'agreement_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



116
117
118
119
120
121
122
123
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 116

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reason == o.reason &&
      previous_transaction_id == o.previous_transaction_id &&
      original_authorized_amount == o.original_authorized_amount &&
      agreement_id == o.agreement_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 161

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 227

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 140

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


127
128
129
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 127

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 133

def hash
  [reason, previous_transaction_id, original_authorized_amount, agreement_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



85
86
87
88
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 85

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



207
208
209
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 207

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



213
214
215
216
217
218
219
220
221
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 213

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



201
202
203
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 201

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



92
93
94
 
# File 'lib/cybersource_rest_client/models/merchant_initiated_transaction_object.rb', line 92

def valid?
  true
end