Class: CyberSource::V2paymentsPointOfSaleInformationEmv

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V2paymentsPointOfSaleInformationEmv

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 56

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

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

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

  if attributes.has_key?(:'fallback')
    self.fallback = attributes[:'fallback']
  else
    self.fallback = false
  end

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

Instance Attribute Details

#card_sequence_number ⇒ Object

Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request.



24
25
26
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 24

def card_sequence_number
  @card_sequence_number
end

#cardholder_verification_method ⇒ Object

Method that was used to verify the cardholder’s identity. Possible values: - 0: No verification - 1: Signature This field is supported only on **American Express Direct**.



21
22
23
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 21

def cardholder_verification_method
  @cardholder_verification_method
end

#fallback ⇒ Object

Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pos_entry_mode field to indicate whether the information was swiped or keyed. This field is supported only on **Chase Paymentech Solutions** and GPN.



27
28
29
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 27

def fallback
  @fallback
end

#fallback_condition ⇒ Object

Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons: - Technical failure: the EMV terminal or EMV card cannot read and process chip data. - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you. Possible values: - 1: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal either used information from a successful chip read or it was not a chip transaction. - 2: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful. This field is supported only on GPN.



30
31
32
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 30

def fallback_condition
  @fallback_condition
end

#tags ⇒ Object

EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. ‘Important` The following tags contain sensitive information and **must not** be included in this field: - 56: Track 1 equivalent data - 57: Track 2 equivalent data - 5A: Application PAN - 5F20: Cardholder name - 5F24: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six) - 99: Transaction PIN - 9F0B: Cardholder name (extended) - 9F1F: Track 1 discretionary data - 9F20: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. `Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - 95: Terminal verification results - 9F10: Issuer application data - 9F26: Application cryptogram



18
19
20
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 18

def tags
  @tags
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 33

def self.attribute_map
  {
    :'tags' => :'tags',
    :'cardholder_verification_method' => :'cardholderVerificationMethod',
    :'card_sequence_number' => :'cardSequenceNumber',
    :'fallback' => :'fallback',
    :'fallback_condition' => :'fallbackCondition'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 44

def self.swagger_types
  {
    :'tags' => :'String',
    :'cardholder_verification_method' => :'Float',
    :'card_sequence_number' => :'String',
    :'fallback' => :'BOOLEAN',
    :'fallback_condition' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



130
131
132
133
134
135
136
137
138
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 130

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      tags == o.tags &&
      cardholder_verification_method == o.cardholder_verification_method &&
      card_sequence_number == o.card_sequence_number &&
      fallback == o.fallback &&
      fallback_condition == o.fallback_condition
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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 176

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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 242

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 155

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


142
143
144
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 142

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



148
149
150
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 148

def hash
  [tags, cardholder_verification_method, card_sequence_number, fallback, fallback_condition].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



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 87

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

  if !@card_sequence_number.nil? && @card_sequence_number.to_s.length > 3
    invalid_properties.push('invalid value for "card_sequence_number", the character length must be smaller than or equal to 3.')
  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



222
223
224
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 222

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



228
229
230
231
232
233
234
235
236
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 228

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



216
217
218
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 216

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



102
103
104
105
106
 
# File 'lib/cyberSource_client/models/v2payments_point_of_sale_information_emv.rb', line 102

def valid?
  return false if !@tags.nil? && @tags.to_s.length > 1998
  return false if !@card_sequence_number.nil? && @card_sequence_number.to_s.length > 3
  true
end