Class: CyberSource::V2paymentsPaymentInformationTokenizedCard

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V2paymentsPaymentInformationTokenizedCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
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
121
122
123
124
125
126
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 81

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assurance_level ⇒ Object

Confidence level of the tokenization. This value is assigned by the token service provider. ‘Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.



39
40
41
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 39

def assurance_level
  @assurance_level
end

#cryptogram ⇒ Object

This field is used internally.



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

def cryptogram
  @cryptogram
end

#expiration_month ⇒ Object

Two-digit month in which the payment network token expires. ‘Format: MM`. Possible values: 01 through 12.



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

def expiration_month
  @expiration_month
end

#expiration_year ⇒ Object

Four-digit year in which the payment network token expires. ‘Format: YYYY`.



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

def expiration_year
  @expiration_year
end

#number ⇒ Object

Customer’s payment network token value.



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

def number
  @number
end

#requestor_id ⇒ Object

Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. ‘Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.



33
34
35
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 33

def requestor_id
  @requestor_id
end

#security_code ⇒ Object

CVN.



45
46
47
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 45

def security_code
  @security_code
end

#storage_method ⇒ Object

Type of technology used in the device to store token data. Possible values: - 001: Secure Element (SE) Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment credentials, a SE is tested against a set of requirements defined by the payment networks. ‘Note` This field is supported only for **FDC Compass**. - 002: Host Card Emulation (HCE) Emulation of a smart card by using software to create a virtual and exact representation of the card. Sensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database must meet very stringent security requirements that exceed PCI DSS. `Note` This field is supported only for **FDC Compass**.



42
43
44
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 42

def storage_method
  @storage_method
end

#transaction_type ⇒ Object

Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Set the value for this field to 1. An application on the customer’s mobile device provided the token data.



36
37
38
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 36

def transaction_type
  @transaction_type
end

#type ⇒ Object

Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 48

def self.attribute_map
  {
    :'number' => :'number',
    :'expiration_month' => :'expirationMonth',
    :'expiration_year' => :'expirationYear',
    :'type' => :'type',
    :'cryptogram' => :'cryptogram',
    :'requestor_id' => :'requestorId',
    :'transaction_type' => :'transactionType',
    :'assurance_level' => :'assuranceLevel',
    :'storage_method' => :'storageMethod',
    :'security_code' => :'securityCode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 64

def self.swagger_types
  {
    :'number' => :'String',
    :'expiration_month' => :'String',
    :'expiration_year' => :'String',
    :'type' => :'String',
    :'cryptogram' => :'String',
    :'requestor_id' => :'String',
    :'transaction_type' => :'String',
    :'assurance_level' => :'String',
    :'storage_method' => :'String',
    :'security_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 293

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      number == o.number &&
      expiration_month == o.expiration_month &&
      expiration_year == o.expiration_year &&
      type == o.type &&
      cryptogram == o.cryptogram &&
      requestor_id == o.requestor_id &&
      transaction_type == o.transaction_type &&
      assurance_level == o.assurance_level &&
      storage_method == o.storage_method &&
      security_code == o.security_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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 344

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



410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 410

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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 323

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


310
311
312
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 310

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



316
317
318
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 316

def hash
  [number, expiration_month, expiration_year, type, cryptogram, requestor_id, transaction_type, assurance_level, storage_method, security_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



130
131
132
133
134
135
136
137
138
139
140
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
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 130

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

  if !@expiration_month.nil? && @expiration_month.to_s.length > 2
    invalid_properties.push('invalid value for "expiration_month", the character length must be smaller than or equal to 2.')
  end

  if !@expiration_year.nil? && @expiration_year.to_s.length > 4
    invalid_properties.push('invalid value for "expiration_year", the character length must be smaller than or equal to 4.')
  end

  if !@type.nil? && @type.to_s.length > 3
    invalid_properties.push('invalid value for "type", the character length must be smaller than or equal to 3.')
  end

  if !@cryptogram.nil? && @cryptogram.to_s.length > 40
    invalid_properties.push('invalid value for "cryptogram", the character length must be smaller than or equal to 40.')
  end

  if !@requestor_id.nil? && @requestor_id.to_s.length > 11
    invalid_properties.push('invalid value for "requestor_id", the character length must be smaller than or equal to 11.')
  end

  if !@transaction_type.nil? && @transaction_type.to_s.length > 1
    invalid_properties.push('invalid value for "transaction_type", the character length must be smaller than or equal to 1.')
  end

  if !@assurance_level.nil? && @assurance_level.to_s.length > 2
    invalid_properties.push('invalid value for "assurance_level", the character length must be smaller than or equal to 2.')
  end

  if !@storage_method.nil? && @storage_method.to_s.length > 3
    invalid_properties.push('invalid value for "storage_method", the character length must be smaller than or equal to 3.')
  end

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



390
391
392
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 390

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



396
397
398
399
400
401
402
403
404
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 396

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



384
385
386
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 384

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



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb', line 177

def valid?
  return false if !@number.nil? && @number.to_s.length > 20
  return false if !@expiration_month.nil? && @expiration_month.to_s.length > 2
  return false if !@expiration_year.nil? && @expiration_year.to_s.length > 4
  return false if !@type.nil? && @type.to_s.length > 3
  return false if !@cryptogram.nil? && @cryptogram.to_s.length > 40
  return false if !@requestor_id.nil? && @requestor_id.to_s.length > 11
  return false if !@transaction_type.nil? && @transaction_type.to_s.length > 1
  return false if !@assurance_level.nil? && @assurance_level.to_s.length > 2
  return false if !@storage_method.nil? && @storage_method.to_s.length > 3
  return false if !@security_code.nil? && @security_code.to_s.length > 4
  true
end