Class: CyberSource::TssV2TransactionsGet200ResponseProcessorInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TssV2TransactionsGet200ResponseProcessorInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 91

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?(:'processor')
    self.processor = attributes[:'processor']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ach_verification ⇒ Object

Returns the value of attribute ach_verification.



41
42
43
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 41

def ach_verification
  @ach_verification
end

#approval_code ⇒ Object

Authorization code. Returned only when the processor returns this value.



32
33
34
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 32

def approval_code
  @approval_code
end

#avs ⇒ Object

Returns the value of attribute avs.



37
38
39
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 37

def avs
  @avs
end

#card_verification ⇒ Object

Returns the value of attribute card_verification.



39
40
41
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 39

def card_verification
  @card_verification
end

#electronic_verification_results ⇒ Object

Returns the value of attribute electronic_verification_results.



43
44
45
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 43

def electronic_verification_results
  @electronic_verification_results
end

#network_transaction_id ⇒ Object

The description for this field is not available.



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

def network_transaction_id
  @network_transaction_id
end

#processor ⇒ Object

Returns the value of attribute processor.



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

def processor
  @processor
end

#provider_transaction_id ⇒ Object

The description for this field is not available.



29
30
31
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 29

def provider_transaction_id
  @provider_transaction_id
end

#response_code ⇒ Object

For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. Important Do not use this field to evaluate the result of the authorization. #### AIBMS If this value is ‘08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `responseCategoryCode` field.



35
36
37
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 35

def response_code
  @response_code
end

#response_code_source ⇒ Object

Used by Visa only and contains the response source/reason code that identifies the source of the response decision.



49
50
51
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 49

def response_code_source
  @response_code_source
end

#response_id ⇒ Object

The description for this field is not available.



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

def response_id
  @response_id
end

#system_trace_audit_number ⇒ Object

This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer’s receipt. For details, see ‘receipt_number` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



46
47
48
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 46

def system_trace_audit_number
  @system_trace_audit_number
end

#transaction_id ⇒ Object

Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see "Network Transaction Identifiers" in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



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

def transaction_id
  @transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 52

def self.attribute_map
  {
    :'processor' => :'processor',
    :'transaction_id' => :'transactionId',
    :'network_transaction_id' => :'networkTransactionId',
    :'response_id' => :'responseId',
    :'provider_transaction_id' => :'providerTransactionId',
    :'approval_code' => :'approvalCode',
    :'response_code' => :'responseCode',
    :'avs' => :'avs',
    :'card_verification' => :'cardVerification',
    :'ach_verification' => :'achVerification',
    :'electronic_verification_results' => :'electronicVerificationResults',
    :'system_trace_audit_number' => :'systemTraceAuditNumber',
    :'response_code_source' => :'responseCodeSource'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 71

def self.swagger_types
  {
    :'processor' => :'TssV2TransactionsGet200ResponseProcessorInformationProcessor',
    :'transaction_id' => :'String',
    :'network_transaction_id' => :'String',
    :'response_id' => :'String',
    :'provider_transaction_id' => :'String',
    :'approval_code' => :'String',
    :'response_code' => :'String',
    :'avs' => :'PtsV2PaymentsPost201ResponseProcessorInformationAvs',
    :'card_verification' => :'Riskv1decisionsCardVerification',
    :'ach_verification' => :'PtsV2PaymentsPost201ResponseProcessorInformationAchVerification',
    :'electronic_verification_results' => :'TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults',
    :'system_trace_audit_number' => :'String',
    :'response_code_source' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      processor == o.processor &&
      transaction_id == o.transaction_id &&
      network_transaction_id == o.network_transaction_id &&
      response_id == o.response_id &&
      provider_transaction_id == o.provider_transaction_id &&
      approval_code == o.approval_code &&
      response_code == o.response_code &&
      avs == o.avs &&
      card_verification == o.card_verification &&
      ach_verification == o.ach_verification &&
      electronic_verification_results == o.electronic_verification_results &&
      system_trace_audit_number == o.system_trace_audit_number &&
      response_code_source == o.response_code_source
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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 279

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 345

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 258

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("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{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


245
246
247
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



251
252
253
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 251

def hash
  [processor, transaction_id, network_transaction_id, response_id, provider_transaction_id, approval_code, response_code, avs, card_verification, ach_verification, electronic_verification_results, system_trace_audit_number, response_code_source].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



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 152

def list_invalid_properties
  invalid_properties = Array.new
  if !@transaction_id.nil? && @transaction_id.to_s.length > 50
    invalid_properties.push('invalid value for "transaction_id", the character length must be smaller than or equal to 50.')
  end

  if !@response_code.nil? && @response_code.to_s.length > 10
    invalid_properties.push('invalid value for "response_code", the character length must be smaller than or equal to 10.')
  end

  if !@system_trace_audit_number.nil? && @system_trace_audit_number.to_s.length > 6
    invalid_properties.push('invalid value for "system_trace_audit_number", the character length must be smaller than or equal to 6.')
  end

  if !@response_code_source.nil? && @response_code_source.to_s.length > 1
    invalid_properties.push('invalid value for "response_code_source", the character length must be smaller than or equal to 1.')
  end

  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



325
326
327
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 325

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



331
332
333
334
335
336
337
338
339
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 331

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



319
320
321
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 319

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



175
176
177
178
179
180
181
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_processor_information.rb', line 175

def valid?
  return false if !@transaction_id.nil? && @transaction_id.to_s.length > 50
  return false if !@response_code.nil? && @response_code.to_s.length > 10
  return false if !@system_trace_audit_number.nil? && @system_trace_audit_number.to_s.length > 6
  return false if !@response_code_source.nil? && @response_code_source.to_s.length > 1
  true
end