Class: CyberSource::PtsV2PaymentsReversalsPost201ResponseProcessorInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PaymentsReversalsPost201ResponseProcessorInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
120
121
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 84

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

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

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

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

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

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

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

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

Instance Attribute Details

#forwarded_acquirer_code ⇒ Object

Name of the Japanese acquirer that processed the transaction. Returned only for JCN Gateway. Please contact the CyberSource Japan Support Group for more information.



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

def forwarded_acquirer_code
  @forwarded_acquirer_code
end

#master_card_service_code ⇒ Object

Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. Note This field is returned only for CyberSource through VisaNet.



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

def master_card_service_code
  @master_card_service_code
end

#master_card_service_reply_code ⇒ Object

Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource. Possible values: - ‘C`: Service completed successfully. - `F`: One of the following: - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or authorization reversal. - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request. - Token requestor ID is missing or formatted incorrectly. - `I`: One of the following: - Invalid token requestor ID. - Suspended or deactivated token. - Invalid token (not in mapping table). - `T`: Invalid combination of token requestor ID and token. - `U`: Expired token. - `W`: Primary account number (PAN) listed in electronic warning bulletin. Note This field is returned only for **CyberSource through VisaNet**.



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

def master_card_service_reply_code
  @master_card_service_reply_code
end

#provider_response ⇒ Object

Processor response to the API request.



38
39
40
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 38

def provider_response
  @provider_response
end

#response_category_code ⇒ Object

Processor-defined response category code. The associated detail error code is in the ‘processorInformation.responseCode` or `issuerInformation.responseCode` field of the service you requested. This field is supported only for: - Japanese issuers - Domestic transactions in Japan - Comercio Latino—processor transaction ID required for troubleshooting #### Maximum length for processors - Comercio Latino: 36 - All other processors: 3



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

def response_category_code
  @response_category_code
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)



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

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**.



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

def response_details
  @response_details
end

#transaction_id ⇒ Object

Processor transaction ID. This value identifies the transaction on a host system. This value is supported only for Moneris. It contains this 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



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

def transaction_id
  @transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 41

def self.attribute_map
  {
    :'transaction_id' => :'transactionId',
    :'response_code' => :'responseCode',
    :'response_category_code' => :'responseCategoryCode',
    :'forwarded_acquirer_code' => :'forwardedAcquirerCode',
    :'master_card_service_code' => :'masterCardServiceCode',
    :'master_card_service_reply_code' => :'masterCardServiceReplyCode',
    :'response_details' => :'responseDetails',
    :'provider_response' => :'providerResponse'
  }
end

.json_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 55

def self.json_map
  {
    :'transaction_id' => :'transaction_id',
    :'response_code' => :'response_code',
    :'response_category_code' => :'response_category_code',
    :'forwarded_acquirer_code' => :'forwarded_acquirer_code',
    :'master_card_service_code' => :'master_card_service_code',
    :'master_card_service_reply_code' => :'master_card_service_reply_code',
    :'response_details' => :'response_details',
    :'provider_response' => :'provider_response'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 69

def self.swagger_types
  {
    :'transaction_id' => :'String',
    :'response_code' => :'String',
    :'response_category_code' => :'String',
    :'forwarded_acquirer_code' => :'String',
    :'master_card_service_code' => :'String',
    :'master_card_service_reply_code' => :'String',
    :'response_details' => :'String',
    :'provider_response' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      transaction_id == o.transaction_id &&
      response_code == o.response_code &&
      response_category_code == o.response_category_code &&
      forwarded_acquirer_code == o.forwarded_acquirer_code &&
      master_card_service_code == o.master_card_service_code &&
      master_card_service_reply_code == o.master_card_service_reply_code &&
      response_details == o.response_details &&
      provider_response == o.provider_response
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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 229

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 295

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 208

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


195
196
197
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [transaction_id, response_code, response_category_code, forwarded_acquirer_code, master_card_service_code, master_card_service_reply_code, response_details, provider_response].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



125
126
127
128
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 125

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



275
276
277
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 275

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



281
282
283
284
285
286
287
288
289
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 281

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



269
270
271
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 269

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



132
133
134
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_reversals_post201_response_processor_information.rb', line 132

def valid?
  true
end