Class: CyberSource::Riskv1authenticationexemptionsPaymentInformationCard

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1authenticationexemptionsPaymentInformationCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 56

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

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

Instance Attribute Details

#bin ⇒ Object

description: The BIN is the first six digits of the card’s Primary Account Number (PAN).



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

def bin
  @bin
end

#expiration_month ⇒ Object

Two-digit month in which the payment card expires. Format: ‘MM`. Valid values: `01` through `12`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (type=039), if there is no expiration date on the card, use `12`. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expmo` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def expiration_month
  @expiration_month
end

#expiration_year ⇒ Object

Four-digit year in which the credit card expires. Format: ‘YYYY`. #### Barclays and Streamline For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. #### Encoded Account Numbers For encoded account numbers (type`=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def expiration_year
  @expiration_year
end

#number ⇒ Object

The customer’s payment card number, also known as the Primary Account Number (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the ‘customer_cc_number` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def number
  @number
end

#type ⇒ Object

Three-digit value that indicates the card type. Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 036: Cartes Bancaires - 039 Encoded account number - 042: Maestro (International) For the complete list of possible values, see ‘card_type` field description in the [Credit Card Services Using the SCMP API Guide.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 33

def self.attribute_map
  {
    :'bin' => :'bin',
    :'type' => :'type',
    :'expiration_month' => :'expirationMonth',
    :'expiration_year' => :'expirationYear',
    :'number' => :'number'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 44

def self.swagger_types
  {
    :'bin' => :'String',
    :'type' => :'String',
    :'expiration_month' => :'String',
    :'expiration_year' => :'String',
    :'number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 199

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 245

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 311

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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 224

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


211
212
213
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



217
218
219
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 217

def hash
  [bin, type, expiration_month, expiration_year, number].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @bin.nil?
    invalid_properties.push('invalid value for "bin", bin cannot be nil.')
  end

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

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

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

  if @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?
    invalid_properties.push('invalid value for "expiration_year", expiration_year cannot be nil.')
  end

  if @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 @number.nil?
    invalid_properties.push('invalid value for "number", number cannot be nil.')
  end

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



291
292
293
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 291

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



297
298
299
300
301
302
303
304
305
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 297

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



285
286
287
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 285

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



128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/cybersource_rest_client/models/riskv1authenticationexemptions_payment_information_card.rb', line 128

def valid?
  return false if @bin.nil?
  return false if @bin.to_s.length > 6
  return false if @type.nil?
  return false if @expiration_month.nil?
  return false if @expiration_month.to_s.length > 2
  return false if @expiration_year.nil?
  return false if @expiration_year.to_s.length > 4
  return false if @number.nil?
  return false if @number.to_s.length > 20
  true
end