Class: CyberSource::PtsV2PaymentsPost201ResponseClearingInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PaymentsPost201ResponseClearingInformation

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

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

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

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

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

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

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

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

Instance Attribute Details

#accountfunding_source ⇒ Object

This field contains the product account funding source value from Visa required for Clearing. Use this field only for clearing with your acquirer. Possible values: - C (Credit) - D (Debit) - H (Charge) - P (Prepaid) - R (Deferred debit)



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

def accountfunding_source
  @accountfunding_source
end

#authorization_characteristics_indicator ⇒ Object

This field contains the code used by the acquirer to request CPS qualification. If applicable, V.I.P. changes the code to reflect the results of its CPS evaluation. Use this field only for clearing with your acquirer.



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

def authorization_characteristics_indicator
  @authorization_characteristics_indicator
end

#cardholder_id_method ⇒ Object

This 1-digit code identifies the cardholder identification method used for a transaction. Use this field only for clearing with your acquirer. Possible values: - 0 - Not specified - 1 - Signature - 2 - Online PIN - 3 - Unattended terminal, no PIN pad - 4 - Mail/Telephone/Electronic Commerce



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

def cardholder_id_method
  @cardholder_id_method
end

#electronic_commerce_indicator ⇒ Object

This field contains 2-digit code that identifies the level of security used in an electronic commerce transaction over an open network (for example, the Internet) or the type of mail or telephone order. Use this field only for clearing with your acquirer. Possible values: - 00 - Not applicable - 01 - Single transaction of a mail/phone order - 02 - Recurring transaction - 03 - Installment payment - 04 - Unknown classification - 05 - Secure electronic commerce transaction - 06 - Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure - 07 - Non-authenticated Security Transaction - 08 - Non-secure transaction



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

def electronic_commerce_indicator
  @electronic_commerce_indicator
end

#market_specific_data_identifier ⇒ Object

This field contains the industry for which market-specific data has been provided. Use this field only for clearing with your acquirer. Possible values: - A: Auto Rental - B: Bill Payment - E: Electronic commerce transaction aggregation - H: Hotel - J: B2B invoice payments - M: Healthcare (medical) - N: Failed Market-Specific Data edit, or not applicable - T: Transit (in healthcare transactions only) - X: Extended Authorization



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

def market_specific_data_identifier
  @market_specific_data_identifier
end

#pos_entry_mode ⇒ Object

This field contains a 4-digit code indicating the method used to enter the account number and card expiration date and, if an electronic terminal is used, the capability of the terminal to capture online PINs for transactions processed through VisaNet. Use this field only for clearing with your acquirer. Possible Values: Positions 1-2: PAN and Date Entry Mode - 00 - Unknown or terminal not used. - 01 - Manual (key entry). - 02 - Visa: Magnetic stripe read; CVV checking may not be possible. PLUS: Track 2 contents read, but transaction not eligible for CVV checking. - 03 - Optical code - 04 - Reserved for future use. - 05 - Contact integrated circuit card read using VSDC chip data rules; Online CAM authentication method; iCVV checking possible. - 06 - Reserved for future use. - 07 - Contactless device-read-originated using qVSDC chip data rules; Online CAM authentication method; iCVV checking possible. - 10 - Credential on file: Transaction initiated using a credential that has previously been stored on file. - 90 - Magnetic stripe read and exact content of Track 1 or Track 2 included (CVV check possible). - 91 - Contactless device-read-originated using magnetic stripe data rules; dCVV checking is possible; Online CAM checking possible for MSD CVN 17 only. - 95 - Integrated circuit card read; CVV or iCVV checking may not be possible. Position 3: PIN Entry Capability - 0 - Unknown. - 1 - Indicates terminal can accept and forward online PINs. - 2 - Indicates terminal cannot accept and forward online PINs. - 8 - Terminal PIN pad down. - 9 - Reserved for future use. Position 4: Fill - 0 - Unused.



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

def pos_entry_mode
  @pos_entry_mode
end

#spend_qualified_indicator ⇒ Object

This field is determined using the point-of-sale spend history and the defined product-level spend requirement for the country of issuance. Use this field only for clearing with your acquirer. Possible values: - Space - Spend-processing does not apply. - B - Base spend-assessment threshold defined by Visa has been met. - N - Spend-assessment threshold defined by Visa has not been met. - Q - Qualified spend-assessment threshold defined by Visa has been met.



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

def spend_qualified_indicator
  @spend_qualified_indicator
end

#validation_code ⇒ Object

This field ensures that key fields used in authorization messages match their respective fields in clearing transaction. Use this field only for clearing with your acquirer.



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

def validation_code
  @validation_code
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_post201_response_clearing_information.rb', line 41

def self.attribute_map
  {
    :'authorization_characteristics_indicator' => :'authorizationCharacteristicsIndicator',
    :'accountfunding_source' => :'accountfundingSource',
    :'cardholder_id_method' => :'cardholderIdMethod',
    :'market_specific_data_identifier' => :'marketSpecificDataIdentifier',
    :'pos_entry_mode' => :'posEntryMode',
    :'electronic_commerce_indicator' => :'electronicCommerceIndicator',
    :'spend_qualified_indicator' => :'spendQualifiedIndicator',
    :'validation_code' => :'validationCode'
  }
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_post201_response_clearing_information.rb', line 55

def self.json_map
  {
    :'authorization_characteristics_indicator' => :'authorization_characteristics_indicator',
    :'accountfunding_source' => :'accountfunding_source',
    :'cardholder_id_method' => :'cardholder_id_method',
    :'market_specific_data_identifier' => :'market_specific_data_identifier',
    :'pos_entry_mode' => :'pos_entry_mode',
    :'electronic_commerce_indicator' => :'electronic_commerce_indicator',
    :'spend_qualified_indicator' => :'spend_qualified_indicator',
    :'validation_code' => :'validation_code'
  }
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_post201_response_clearing_information.rb', line 69

def self.swagger_types
  {
    :'authorization_characteristics_indicator' => :'String',
    :'accountfunding_source' => :'String',
    :'cardholder_id_method' => :'String',
    :'market_specific_data_identifier' => :'String',
    :'pos_entry_mode' => :'String',
    :'electronic_commerce_indicator' => :'String',
    :'spend_qualified_indicator' => :'String',
    :'validation_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_clearing_information.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      authorization_characteristics_indicator == o.authorization_characteristics_indicator &&
      accountfunding_source == o.accountfunding_source &&
      cardholder_id_method == o.cardholder_id_method &&
      market_specific_data_identifier == o.market_specific_data_identifier &&
      pos_entry_mode == o.pos_entry_mode &&
      electronic_commerce_indicator == o.electronic_commerce_indicator &&
      spend_qualified_indicator == o.spend_qualified_indicator &&
      validation_code == o.validation_code
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



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
266
267
268
269
270
271
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_clearing_information.rb', line 235

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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_clearing_information.rb', line 301

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_clearing_information.rb', line 214

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [authorization_characteristics_indicator, accountfunding_source, cardholder_id_method, market_specific_data_identifier, pos_entry_mode, electronic_commerce_indicator, spend_qualified_indicator, validation_code].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_post201_response_clearing_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



281
282
283
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_clearing_information.rb', line 281

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



287
288
289
290
291
292
293
294
295
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_clearing_information.rb', line 287

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



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

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_post201_response_clearing_information.rb', line 132

def valid?
  true
end