Class: VRPayment::AuthenticatedCardDataCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AuthenticatedCardDataCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
127
128
129
130
131
132
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 87

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#card_holder_name ⇒ Object

The name of the cardholder, as printed on the card, identifying the card owner.



24
25
26
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 24

def card_holder_name
  @card_holder_name
end

#card_verification_code ⇒ Object

The security code used to validate the card during transactions.



27
28
29
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 27

def card_verification_code
  @card_verification_code
end

#cardholder_authentication ⇒ Object

Optional authentication details for the cardholder, such as 3D Secure authentication, used when the cardholder has already been verified during the transaction for added security.



30
31
32
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 30

def cardholder_authentication
  @cardholder_authentication
end

#cryptogram ⇒ Object

An additional authentication value that enhances the security of tokenized card transactions.



33
34
35
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 33

def cryptogram
  @cryptogram
end

#expiry_date ⇒ Object

The expiry date of the card, indicating its validity period in yyyy-mm format (e.g., 2023-09).



36
37
38
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 36

def expiry_date
  @expiry_date
end

#pan_type ⇒ Object

The type of PAN or token, indicating the source or security method of the card information.



39
40
41
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 39

def pan_type
  @pan_type
end

#primary_account_number ⇒ Object

The card’s primary account number (PAN), the unique identifier of the card.



42
43
44
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 42

def 
  @primary_account_number
end

#recurring_indicator ⇒ Object

The indicator used to distinguish between recurring and one-time transactions. If omitted, it will be automatically determined based on the transaction’s properties.



45
46
47
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 45

def recurring_indicator
  @recurring_indicator
end

#scheme_transaction_reference ⇒ Object

A reference specific to the card’s transaction within its payment scheme.



48
49
50
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 48

def scheme_transaction_reference
  @scheme_transaction_reference
end

#token_requestor_id ⇒ Object

The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.



51
52
53
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 51

def token_requestor_id
  @token_requestor_id
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 54

def self.attribute_map
  {
    :'card_holder_name' => :'cardHolderName',
    :'card_verification_code' => :'cardVerificationCode',
    :'cardholder_authentication' => :'cardholderAuthentication',
    :'cryptogram' => :'cryptogram',
    :'expiry_date' => :'expiryDate',
    :'pan_type' => :'panType',
    :'primary_account_number' => :'primaryAccountNumber',
    :'recurring_indicator' => :'recurringIndicator',
    :'scheme_transaction_reference' => :'schemeTransactionReference',
    :'token_requestor_id' => :'tokenRequestorId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 70

def self.swagger_types
  {
    :'card_holder_name' => :'String',
    :'card_verification_code' => :'String',
    :'cardholder_authentication' => :'CardholderAuthenticationCreate',
    :'cryptogram' => :'CardCryptogramCreate',
    :'expiry_date' => :'String',
    :'pan_type' => :'PanType',
    :'primary_account_number' => :'String',
    :'recurring_indicator' => :'RecurringIndicator',
    :'scheme_transaction_reference' => :'String',
    :'token_requestor_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 236

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      card_holder_name == o.card_holder_name &&
      card_verification_code == o.card_verification_code &&
      cardholder_authentication == o.cardholder_authentication &&
      cryptogram == o.cryptogram &&
      expiry_date == o.expiry_date &&
      pan_type == o.pan_type &&
       == o. &&
      recurring_indicator == o.recurring_indicator &&
      scheme_transaction_reference == o.scheme_transaction_reference &&
      token_requestor_id == o.token_requestor_id
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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 287

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 = VRPayment.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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 353

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 266

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 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


253
254
255
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



259
260
261
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 259

def hash
  [card_holder_name, card_verification_code, cardholder_authentication, cryptogram, expiry_date, pan_type, , recurring_indicator, scheme_transaction_reference, token_requestor_id].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



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
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 136

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

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

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

  if @primary_account_number.nil?
    invalid_properties.push('invalid value for "primary_account_number", primary_account_number cannot be nil.')
  end

  if @primary_account_number.to_s.length > 30
    invalid_properties.push('invalid value for "primary_account_number", the character length must be smaller than or equal to 30.')
  end

  if @primary_account_number.to_s.length < 10
    invalid_properties.push('invalid value for "primary_account_number", the character length must be great than or equal to 10.')
  end

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



333
334
335
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 333

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



339
340
341
342
343
344
345
346
347
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 339

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



327
328
329
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 327

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



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/vrpayment-ruby-sdk/models/authenticated_card_data_create.rb', line 171

def valid?
  return false if !@card_holder_name.nil? && @card_holder_name.to_s.length > 100
  return false if !@card_verification_code.nil? && @card_verification_code.to_s.length > 4
  return false if !@card_verification_code.nil? && @card_verification_code.to_s.length < 3
  return false if @primary_account_number.nil?
  return false if @primary_account_number.to_s.length > 30
  return false if @primary_account_number.to_s.length < 10
  return false if !@scheme_transaction_reference.nil? && @scheme_transaction_reference.to_s.length > 100
  true
end