Class: CyberSource::PaymentInstrumentCard

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PaymentInstrumentCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 88

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

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

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

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

Instance Attribute Details

#expiration_month ⇒ Object

Two-digit month in which the credit card expires. Format: ‘MM` Possible values: `01` through `12` This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.



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

def expiration_month
  @expiration_month
end

#expiration_year ⇒ Object

Four-digit year in which the credit card expires. Format: ‘YYYY`. Possible values: `1900` through `2099`. **FDC Nashville Global and FDMS South** You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.’



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

def expiration_year
  @expiration_year
end

#issue_number ⇒ Object

Number of times a Maestro (UK Domestic) card has been issued to the account holder.



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

def issue_number
  @issue_number
end

#start_month ⇒ Object

Month of the start of the Maestro (UK Domestic) card validity period. Format: ‘MM`. Possible values: `01` through `12`.



30
31
32
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 30

def start_month
  @start_month
end

#start_year ⇒ Object

Year of the start of the Maestro (UK Domestic) card validity period. Format: ‘YYYY`. Possible values: `1900` through `2099`.



33
34
35
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 33

def start_year
  @start_year
end

#type ⇒ Object

Type of credit card. Possible values: * Visa (001) * Mastercard (002) - Eurocard—European regional brand of Mastercard * American Express (003) * Discover (004) * Diners Club (005) * Carte Blanche (006) * JCB (007) * Optima (008) * Twinpay Credit (011) * Twinpay Debit (012) * Walmart (013) * EnRoute (014) * Lowes consumer (015) * Home Depot consumer (016) * MBNA (017) * Dicks Sportswear (018) * Casual Corner (019) * Sears (020) * JAL (021) * Disney (023) * Maestro (024) - UK Domestic * Sams Club consumer (025) * Sams Club business (026) * Nicos (027) * Bill me later (028) * Bebe (029) * Restoration Hardware (030) * Delta (031) — use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types. * Solo (032) * Visa Electron (033) * Dankort (034) * Laser (035) * Carte Bleue (036) — formerly Cartes Bancaires * Cartes Bancaires (036) * Carta Si (037) * pinless debit (038) * encoded account (039) * UATP (040) * Household (041) * Maestro (042) - International * GE Money UK (043) * Korean cards (044) * Style (045) * JCrew (046) * PayEase China processing eWallet (047) * PayEase China processing bank transfer (048) * Meijer Private Label (049) * Hipercard (050) — supported only by the Comercio Latino processor. * Aura (051) — supported only by the Comercio Latino processor. * Redecard (052) * ORICO (053) * Elo (054) — supported only by the Comercio Latino processor. * Capital One Private Label (055) * Synchrony Private Label (056) * Costco Private Label (057) * mada (060) * China Union Pay (062) * Falabella private label (063)



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

def type
  @type
end

#use_as ⇒ Object

Card Use As Field. Supported value of ‘pinless debit` only. Only for use with Pinless Debit tokens.



36
37
38
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 36

def use_as
  @use_as
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 61

def self.attribute_map
  {
    :'expiration_month' => :'expirationMonth',
    :'expiration_year' => :'expirationYear',
    :'type' => :'type',
    :'issue_number' => :'issueNumber',
    :'start_month' => :'startMonth',
    :'start_year' => :'startYear',
    :'use_as' => :'useAs'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 74

def self.swagger_types
  {
    :'expiration_month' => :'String',
    :'expiration_year' => :'String',
    :'type' => :'String',
    :'issue_number' => :'String',
    :'start_month' => :'String',
    :'start_year' => :'String',
    :'use_as' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      expiration_month == o.expiration_month &&
      expiration_year == o.expiration_year &&
      type == o.type &&
      issue_number == o.issue_number &&
      start_month == o.start_month &&
      start_year == o.start_year &&
      use_as == o.use_as
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



323
324
325
326
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
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 323

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 389

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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 302

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


289
290
291
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 289

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



295
296
297
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 295

def hash
  [expiration_month, expiration_year, type, issue_number, start_month, start_year, use_as].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



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
172
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 125

def list_invalid_properties
  invalid_properties = Array.new
  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_month.nil? && @expiration_month.to_s.length < 2
    invalid_properties.push('invalid value for "expiration_month", the character length must be great 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 !@expiration_year.nil? && @expiration_year.to_s.length < 4
    invalid_properties.push('invalid value for "expiration_year", the character length must be great than or equal to 4.')
  end

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

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

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

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

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

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

  if !@start_year.nil? && @start_year.to_s.length < 4
    invalid_properties.push('invalid value for "start_year", the character length must be great 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



369
370
371
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 369

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



375
376
377
378
379
380
381
382
383
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 375

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



363
364
365
 
# File 'lib/cybersource_rest_client/models/payment_instrument_card.rb', line 363

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



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

def valid?
  return false if !@expiration_month.nil? && @expiration_month.to_s.length > 2
  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 !@expiration_year.nil? && @expiration_year.to_s.length < 4
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['visa', 'mastercard', 'american express', 'discover', 'diners club', 'carte blanche', 'jcb', 'optima', 'twinpay credit', 'twinpay debit', 'walmart', 'enroute', 'lowes consumer', 'home depot consumer', 'mbna', 'dicks sportswear', 'casual corner', 'sears', 'jal', 'disney', 'maestro uk domestic', 'sams club consumer', 'sams club business', 'nicos', 'bill me later', 'bebe', 'restoration hardware', 'delta online', 'solo', 'visa electron', 'dankort', 'laser', 'carte bleue', 'carta si', 'pinless debit', 'encoded account', 'uatp', 'household', 'maestro international', 'ge money uk', 'korean cards', 'style', 'jcrew', 'payease china processing ewallet', 'payease china processing bank transfer', 'meijer private label', 'hipercard', 'aura', 'redecard', 'orico', 'elo', 'capital one private label', 'synchrony private label', 'china union pay', 'costco private label', 'mada', 'falabella private label'])
  return false unless type_validator.valid?(@type)
  return false if !@issue_number.nil? && @issue_number.to_s.length > 2
  return false if !@issue_number.nil? && @issue_number.to_s.length < 1
  return false if !@start_month.nil? && @start_month.to_s.length > 2
  return false if !@start_month.nil? && @start_month.to_s.length < 2
  return false if !@start_year.nil? && @start_year.to_s.length > 4
  return false if !@start_year.nil? && @start_year.to_s.length < 4
  true
end