Class: CyberSource::PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
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
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 82

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

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

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

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

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

Instance Attribute Details

#approval_code ⇒ Object

Authorization code. Returned only when the processor returns this value. The length of this value depends on your processor. Returned by authorization service. #### PIN debit Authorization code that is returned by the processor. Returned by PIN debit credit. #### Elavon Encrypted Account Number Program The returned value is OFFLINE. #### TSYS Acquiring Solutions The returned value for a successful zero amount authorization is 000000.



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

def approval_code
  @approval_code
end

#merchant_advice ⇒ Object

Returns the value of attribute merchant_advice.



34
35
36
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 34

def merchant_advice
  @merchant_advice
end

#network_transaction_id ⇒ Object

Same value as ‘processorInformation.transactionId`



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

def network_transaction_id
  @network_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. #### PIN debit Response value that is returned by the processor or bank. Important Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### 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 `processorInformation.responseCategoryCode` field. String (3) #### paypalgateway Processor generated ID for the itemized detail.



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

def response_code
  @response_code
end

#response_details ⇒ Object

This field might contain information about a decline. This field is supported only for **CyberSource through VisaNet**.



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

def response_details
  @response_details
end

#seller_protection ⇒ Object

Returns the value of attribute seller_protection.



36
37
38
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 36

def seller_protection
  @seller_protection
end

#system_trace_audit_number ⇒ Object

This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. Returned by authorization and incremental authorization services. #### 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.



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

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. Returned by the authorization service. #### PIN debit Transaction identifier generated by the processor. Returned by PIN debit credit. #### GPX Processor transaction ID. #### 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 "processorInformation.networkTransactionId" in [REST API Fields](developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) #### Moneris This value identifies the transaction on a host system. It contains the following information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. Example For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003



20
21
22
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_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.



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 39

def self.attribute_map
  {
    :'approval_code' => :'approvalCode',
    :'transaction_id' => :'transactionId',
    :'network_transaction_id' => :'networkTransactionId',
    :'response_code' => :'responseCode',
    :'system_trace_audit_number' => :'systemTraceAuditNumber',
    :'response_details' => :'responseDetails',
    :'merchant_advice' => :'merchantAdvice',
    :'seller_protection' => :'sellerProtection'
  }
end

.json_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 53

def self.json_map
  {
    :'approval_code' => :'approval_code',
    :'transaction_id' => :'transaction_id',
    :'network_transaction_id' => :'network_transaction_id',
    :'response_code' => :'response_code',
    :'system_trace_audit_number' => :'system_trace_audit_number',
    :'response_details' => :'response_details',
    :'merchant_advice' => :'merchant_advice',
    :'seller_protection' => :'seller_protection'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 67

def self.swagger_types
  {
    :'approval_code' => :'String',
    :'transaction_id' => :'String',
    :'network_transaction_id' => :'String',
    :'response_code' => :'String',
    :'system_trace_audit_number' => :'String',
    :'response_details' => :'String',
    :'merchant_advice' => :'PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice',
    :'seller_protection' => :'PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      approval_code == o.approval_code &&
      transaction_id == o.transaction_id &&
      network_transaction_id == o.network_transaction_id &&
      response_code == o.response_code &&
      system_trace_audit_number == o.system_trace_audit_number &&
      response_details == o.response_details &&
      merchant_advice == o.merchant_advice &&
      seller_protection == o.seller_protection
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 215

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 281

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 194

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


181
182
183
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



187
188
189
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 187

def hash
  [approval_code, transaction_id, network_transaction_id, response_code, system_trace_audit_number, response_details, merchant_advice, seller_protection].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



123
124
125
126
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 123

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



261
262
263
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 261

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



267
268
269
270
271
272
273
274
275
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 267

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



255
256
257
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 255

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



130
131
132
 
# File 'lib/cybersource_rest_client/models/pts_v2_incremental_authorization_patch201_response_processor_information.rb', line 130

def valid?
  true
end