Class: CyberSource::Ptsv2creditsPointOfSaleInformationEmv

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2creditsPointOfSaleInformationEmv

Initializes the object

Parameters:

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

    Model attributes in the form of hash



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 46

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?(:'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

#fallbackObject

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 pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - true - false (default) This field is supported only on **Chase Paymentech Solutions** and GPN.



21
22
23
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 21

def fallback
  @fallback
end

#fallback_conditionObject

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. NOTE: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. For details, see the ‘emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)



24
25
26
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 24

def fallback_condition
  @fallback_condition
end

#tagsObject

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. For details, see the ‘emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) Note The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. Note For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: emvco.com 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, and 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_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 18

def tags
  @tags
end

Class Method Details

.attribute_mapObject

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



27
28
29
30
31
32
33
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 27

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

.swagger_typesObject

Attribute type mapping.



36
37
38
39
40
41
42
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 36

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



97
98
99
100
101
102
103
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 97

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 141

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



207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 207

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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 120

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


107
108
109
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 107

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



113
114
115
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 113

def hash
  [tags, fallback, fallback_condition].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



69
70
71
72
73
74
75
76
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 69

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



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

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 193

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



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

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



80
81
82
83
# File 'lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb', line 80

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