Class: CyberSource::PtsV2PaymentsRefundPost201ResponseProcessorInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PaymentsRefundPost201ResponseProcessorInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

Instance Attribute Details

#ach_verification ⇒ Object

Returns the value of attribute ach_verification.



31
32
33
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 31

def ach_verification
  @ach_verification
end

#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_payments_refund_post201_response_processor_information.rb', line 17

def approval_code
  @approval_code
end

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



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

def forwarded_acquirer_code
  @forwarded_acquirer_code
end

#merchant_number ⇒ Object

Identifier that was assigned to you by your acquirer. This value must be printed on the receipt. #### Returned by Authorizations and Credits. This reply field is only supported by merchants who have installed client software on their POS terminals and use these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX



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

def merchant_number
  @merchant_number
end

#network_transaction_id ⇒ Object

Same value as ‘processorInformation.transactionId`



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

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)



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

def response_code
  @response_code
end

#settlement_date ⇒ Object

Field contains a settlement date. The date is in mmdd format, where: mm = month and dd = day.



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

def settlement_date
  @settlement_date
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



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



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

def self.attribute_map
  {
    :'approval_code' => :'approvalCode',
    :'transaction_id' => :'transactionId',
    :'forwarded_acquirer_code' => :'forwardedAcquirerCode',
    :'merchant_number' => :'merchantNumber',
    :'response_code' => :'responseCode',
    :'ach_verification' => :'achVerification',
    :'network_transaction_id' => :'networkTransactionId',
    :'settlement_date' => :'settlementDate'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'approval_code' => :'approval_code',
    :'transaction_id' => :'transaction_id',
    :'forwarded_acquirer_code' => :'forwarded_acquirer_code',
    :'merchant_number' => :'merchant_number',
    :'response_code' => :'response_code',
    :'ach_verification' => :'ach_verification',
    :'network_transaction_id' => :'network_transaction_id',
    :'settlement_date' => :'settlement_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'approval_code' => :'String',
    :'transaction_id' => :'String',
    :'forwarded_acquirer_code' => :'String',
    :'merchant_number' => :'String',
    :'response_code' => :'String',
    :'ach_verification' => :'PtsV2PaymentsPost201ResponseProcessorInformationAchVerification',
    :'network_transaction_id' => :'String',
    :'settlement_date' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      approval_code == o.approval_code &&
      transaction_id == o.transaction_id &&
      forwarded_acquirer_code == o.forwarded_acquirer_code &&
      merchant_number == o.merchant_number &&
      response_code == o.response_code &&
      ach_verification == o.ach_verification &&
      network_transaction_id == o.network_transaction_id &&
      settlement_date == o.settlement_date
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



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
252
253
254
255
256
257
258
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 222

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 288

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 201

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


188
189
190
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 194

def hash
  [approval_code, transaction_id, forwarded_acquirer_code, merchant_number, response_code, ach_verification, network_transaction_id, settlement_date].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



124
125
126
127
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 124

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



268
269
270
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 268

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



274
275
276
277
278
279
280
281
282
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 274

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



262
263
264
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 262

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



131
132
133
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_refund_post201_response_processor_information.rb', line 131

def valid?
  true
end