Class: CityPayApiClient::CardTokenisationRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/citypay_api_client/models/card_tokenisation_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CardTokenisationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



78
79
80
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
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 78

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::CardTokenisationRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::CardTokenisationRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'cardnumber')
    self.cardnumber = attributes[:'cardnumber']
  end

  if attributes.key?(:'csc')
    self.csc = attributes[:'csc']
  end

  if attributes.key?(:'expmonth')
    self.expmonth = attributes[:'expmonth']
  end

  if attributes.key?(:'expyear')
    self.expyear = attributes[:'expyear']
  end

  if attributes.key?(:'name_on_card')
    self.name_on_card = attributes[:'name_on_card']
  end

  if attributes.key?(:'uuid')
    self.uuid = attributes[:'uuid']
  end
end

Instance Attribute Details

#cardnumber ⇒ Object

The card number (PAN) with a variable length to a maximum of 21 digits in numerical form. Any non numeric characters will be stripped out of the card number, this includes whitespace or separators internal of the provided value. The card number must be treated as sensitive data. We only provide an obfuscated value in logging and reporting. The plaintext value is encrypted in our database using AES 256 GMC bit encryption for settlement or refund purposes. When providing the card number to our gateway through the authorisation API you will be handling the card data on your application. This will require further PCI controls to be in place and this value must never be stored.



19
20
21
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 19

def cardnumber
  @cardnumber
end

#csc ⇒ Object

The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify possession of the card as it is not available within the chip or magnetic swipe. When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing. The CSC number aids fraud prevention in Mail Order and Internet payments. Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC. The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored. This applies to all entities handling card data. It should also not be used in any hashing process. CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm.



22
23
24
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 22

def csc
  @csc
end

#expmonth ⇒ Object

The month of expiry of the card. The month value should be a numerical value between 1 and 12.



25
26
27
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 25

def expmonth
  @expmonth
end

#expyear ⇒ Object

The year of expiry of the card.



28
29
30
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 28

def expyear
  @expyear
end

#name_on_card ⇒ Object

The card holder name as appears on the card such as MR N E BODY. Required for some acquirers.



31
32
33
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 31

def name_on_card
  @name_on_card
end

#uuid ⇒ Object

A uuid for the session. The value tracks through 3ds session and therefore should be a valid v4 uuid.



34
35
36
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 34

def uuid
  @uuid
end

Class Method Details

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



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
364
365
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 328

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = CityPayApiClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



49
50
51
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 49

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 54

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 37

def self.attribute_map
  {
    :'cardnumber' => :'cardnumber',
    :'csc' => :'csc',
    :'expmonth' => :'expmonth',
    :'expyear' => :'expyear',
    :'name_on_card' => :'name_on_card',
    :'uuid' => :'uuid'
  }
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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 304

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 71

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 59

def self.openapi_types
  {
    :'cardnumber' => :'String',
    :'csc' => :'String',
    :'expmonth' => :'Integer',
    :'expyear' => :'Integer',
    :'name_on_card' => :'String',
    :'uuid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 278

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cardnumber == o.cardnumber &&
      csc == o.csc &&
      expmonth == o.expmonth &&
      expyear == o.expyear &&
      name_on_card == o.name_on_card &&
      uuid == o.uuid
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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 399

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


291
292
293
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 291

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



297
298
299
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 297

def hash
  [cardnumber, csc, expmonth, expyear, name_on_card, uuid].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



119
120
121
122
123
124
125
126
127
128
129
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
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 119

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@cardnumber.nil? && @cardnumber.to_s.length > 22
    invalid_properties.push('invalid value for "cardnumber", the character length must be smaller than or equal to 22.')
  end

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

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

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

  if !@expmonth.nil? && @expmonth > 12
    invalid_properties.push('invalid value for "expmonth", must be smaller than or equal to 12.')
  end

  if !@expmonth.nil? && @expmonth < 1
    invalid_properties.push('invalid value for "expmonth", must be greater than or equal to 1.')
  end

  if !@expyear.nil? && @expyear > 2100
    invalid_properties.push('invalid value for "expyear", must be smaller than or equal to 2100.')
  end

  if !@expyear.nil? && @expyear < 2000
    invalid_properties.push('invalid value for "expyear", must be greater than or equal to 2000.')
  end

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

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

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

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



375
376
377
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 375

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 381

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



369
370
371
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 369

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/citypay_api_client/models/card_tokenisation_request.rb', line 175

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@cardnumber.nil? && @cardnumber.to_s.length > 22
  return false if !@cardnumber.nil? && @cardnumber.to_s.length < 12
  return false if !@csc.nil? && @csc.to_s.length > 4
  return false if !@csc.nil? && @csc.to_s.length < 3
  return false if !@expmonth.nil? && @expmonth > 12
  return false if !@expmonth.nil? && @expmonth < 1
  return false if !@expyear.nil? && @expyear > 2100
  return false if !@expyear.nil? && @expyear < 2000
  return false if !@name_on_card.nil? && @name_on_card.to_s.length > 45
  return false if !@name_on_card.nil? && @name_on_card.to_s.length < 2
  return false if !@uuid.nil? && @uuid.to_s.length > 36
  return false if !@uuid.nil? && @uuid.to_s.length < 36
  true
end