Class: CyberSource::Tmsv2TokenizedCard

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Tmsv2TokenizedCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 152

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_links ⇒ Object

Returns the value of attribute _links.



16
17
18
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 16

def _links
  @_links
end

#account_reference_id ⇒ Object

An identifier provided by the issuer for the account.



25
26
27
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 25

def 
  @account_reference_id
end

#card ⇒ Object

Returns the value of attribute card.



66
67
68
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 66

def card
  @card
end

#consumer_id ⇒ Object

Identifier of the consumer within the wallet. Maximum 24 characters for VTS.



28
29
30
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 28

def consumer_id
  @consumer_id
end

#create_instrument_identifier ⇒ Object

Specifies whether the InstrumentId should be created (true) or not (false). Possible Values: - ‘true`: The InstrumentId should be created. - `false`: The InstrumentId should be created.



31
32
33
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 31

def create_instrument_identifier
  @create_instrument_identifier
end

#cryptogram ⇒ Object

Value generated by the card association to be used alongside the network token for processing a payment.



46
47
48
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 46

def cryptogram
  @cryptogram
end

#eci ⇒ Object

Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.



52
53
54
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 52

def eci
  @eci
end

#enrollment_id ⇒ Object

Unique id to identify this PAN/ enrollment.



58
59
60
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 58

def enrollment_id
  @enrollment_id
end

#id ⇒ Object

The Id of the Tokenized Card.



19
20
21
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 19

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



70
71
72
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 70

def metadata
  @metadata
end

#number ⇒ Object

The token requestor’s network token for the provided PAN and consumer Id, if available.



43
44
45
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 43

def number
  @number
end

#object ⇒ Object

The type. Possible Values: - tokenizedCard



22
23
24
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 22

def object
  @object
end

#passcode ⇒ Object

Returns the value of attribute passcode.



68
69
70
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 68

def passcode
  @passcode
end

#payment_account_reference ⇒ Object

Payment account reference.



64
65
66
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 64

def 
  @payment_account_reference
end

#reason ⇒ Object

Issuers state for the network token Possible Values: - INVALID_REQUEST : The network token provision request contained invalid data. - CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified. - CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization. - CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization. - DECLINED : Card can currently not be used with issuer for tokenization. - SERVICE_UNAVAILABLE : The network token service was unavailable or timed out. - SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration.



40
41
42
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 40

def reason
  @reason
end

#requestor_id ⇒ Object

11-digit identifier that uniquely identifies the Token Requestor.



55
56
57
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 55

def requestor_id
  @requestor_id
end

#security_code ⇒ Object

4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.



49
50
51
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 49

def security_code
  @security_code
end

#source ⇒ Object

Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER



34
35
36
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 34

def source
  @source
end

#state ⇒ Object

State of the network token or network token provision. Possible Values: ACTIVE : Network token is active. SUSPENDED : Network token is suspended. This state can change back to ACTIVE. DELETED : This is a final state for a network token instance. UNPROVISIONED : A previous network token.



37
38
39
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 37

def state
  @state
end

#token_reference_id ⇒ Object

Unique ID for netwrok token.



61
62
63
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 61

def token_reference_id
  @token_reference_id
end

Class Method Details

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 73

def self.attribute_map
  {
    :'_links' => :'_links',
    :'id' => :'id',
    :'object' => :'object',
    :'account_reference_id' => :'accountReferenceId',
    :'consumer_id' => :'consumerId',
    :'create_instrument_identifier' => :'createInstrumentIdentifier',
    :'source' => :'source',
    :'state' => :'state',
    :'reason' => :'reason',
    :'number' => :'number',
    :'cryptogram' => :'cryptogram',
    :'security_code' => :'securityCode',
    :'eci' => :'eci',
    :'requestor_id' => :'requestorId',
    :'enrollment_id' => :'enrollmentId',
    :'token_reference_id' => :'tokenReferenceId',
    :'payment_account_reference' => :'paymentAccountReference',
    :'card' => :'card',
    :'passcode' => :'passcode',
    :'metadata' => :'metadata'
  }
end

.json_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 99

def self.json_map
  {
    :'_links' => :'_links',
    :'id' => :'id',
    :'object' => :'object',
    :'account_reference_id' => :'account_reference_id',
    :'consumer_id' => :'consumer_id',
    :'create_instrument_identifier' => :'create_instrument_identifier',
    :'source' => :'source',
    :'state' => :'state',
    :'reason' => :'reason',
    :'number' => :'number',
    :'cryptogram' => :'cryptogram',
    :'security_code' => :'security_code',
    :'eci' => :'eci',
    :'requestor_id' => :'requestor_id',
    :'enrollment_id' => :'enrollment_id',
    :'token_reference_id' => :'token_reference_id',
    :'payment_account_reference' => :'payment_account_reference',
    :'card' => :'card',
    :'passcode' => :'passcode',
    :'metadata' => :'metadata'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 125

def self.swagger_types
  {
    :'_links' => :'Tmsv2TokenizedCardLinks',
    :'id' => :'String',
    :'object' => :'String',
    :'account_reference_id' => :'String',
    :'consumer_id' => :'String',
    :'create_instrument_identifier' => :'BOOLEAN',
    :'source' => :'String',
    :'state' => :'String',
    :'reason' => :'String',
    :'number' => :'String',
    :'cryptogram' => :'String',
    :'security_code' => :'String',
    :'eci' => :'String',
    :'requestor_id' => :'String',
    :'enrollment_id' => :'String',
    :'token_reference_id' => :'String',
    :'payment_account_reference' => :'String',
    :'card' => :'Tmsv2TokenizedCardCard',
    :'passcode' => :'Tmsv2TokenizedCardPasscode',
    :'metadata' => :'Tmsv2TokenizedCardMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 266

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _links == o._links &&
      id == o.id &&
      object == o.object &&
       == o. &&
      consumer_id == o.consumer_id &&
      create_instrument_identifier == o.create_instrument_identifier &&
      source == o.source &&
      state == o.state &&
      reason == o.reason &&
      number == o.number &&
      cryptogram == o.cryptogram &&
      security_code == o.security_code &&
      eci == o.eci &&
      requestor_id == o.requestor_id &&
      enrollment_id == o.enrollment_id &&
      token_reference_id == o.token_reference_id &&
       == o. &&
      card == o.card &&
      passcode == o.passcode &&
      metadata == o.metadata
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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 327

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 393

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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 306

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


293
294
295
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 293

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



299
300
301
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 299

def hash
  [_links, id, object, , consumer_id, create_instrument_identifier, source, state, reason, number, cryptogram, security_code, eci, requestor_id, enrollment_id, token_reference_id, , card, passcode, metadata].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



241
242
243
244
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 241

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



373
374
375
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 373

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



379
380
381
382
383
384
385
386
387
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 379

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



367
368
369
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 367

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



248
249
250
 
# File 'lib/cybersource_rest_client/models/tmsv2_tokenized_card.rb', line 248

def valid?
  true
end