Class: CyberSource::Ptsv2paymentsPaymentInformationFluidData

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsPaymentInformationFluidData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 51

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

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

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

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

Instance Attribute Details

#descriptorObject

The identifier for a payment solution, which is sending the encrypted payment data for decryption. Valid values: Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ= Note: For other payment solutions, the value may be specific to the terminal or device initiatinf the payment. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits. Card Present processing: Format of the encrypted payment data. The value for Bluefin PCI P2PE is ‘Ymx1ZWZpbg==`. paymentInformation.fluidData.encoding must be `Base64`. The value for Cybersource P2PE decryption depends on the encoding method used and identified in encoding field. If paymentInformation.fluidData.encoding is `Base64`, the value is: `RklEPUVNVi5QQVlNRU5ULkFQSQ==` If paymentInformation.fluidData.encoding is `HEX`, the value is: `4649443D454D562E5041594D454E542E41504`



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

def descriptor
  @descriptor
end

#encodingObject

Encoding method used to encrypt the payment data. Valid values: ‘Base64`, `HEX` If no value is provided, `Base64` is taken as the default value. And the `Base64` descriptor is used for paymentInformation.fluidData.encoding



27
28
29
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 27

def encoding
  @encoding
end

#key_serial_numberObject

The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html)



18
19
20
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 18

def key_serial_number
  @key_serial_number
end

#valueObject

Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution used by the merchant. Used by Authorization and Standalone Credits. Required for authorizations and standalone credits that use a Cybersource suppored Point-to-Point encryption method. Card Present processing This field represents the encrypted payment data generated by the payment terminal/device.



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

def value
  @value
end

Class Method Details

.attribute_mapObject

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



30
31
32
33
34
35
36
37
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 30

def self.attribute_map
  {
    :'key_serial_number' => :'keySerialNumber',
    :'descriptor' => :'descriptor',
    :'value' => :'value',
    :'encoding' => :'encoding'
  }
end

.swagger_typesObject

Attribute type mapping.



40
41
42
43
44
45
46
47
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 40

def self.swagger_types
  {
    :'key_serial_number' => :'String',
    :'descriptor' => :'String',
    :'value' => :'String',
    :'encoding' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



107
108
109
110
111
112
113
114
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 107

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



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
178
179
180
181
182
183
184
185
186
187
188
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 152

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



218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 218

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 131

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


118
119
120
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 118

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



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

def hash
  [key_serial_number, descriptor, value, encoding].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



76
77
78
79
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 76

def list_invalid_properties
  invalid_properties = Array.new
  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



198
199
200
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 198

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



204
205
206
207
208
209
210
211
212
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 204

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



192
193
194
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 192

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



83
84
85
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_fluid_data.rb', line 83

def valid?
  true
end