Class: CyberSource::V2paymentsPaymentInformationCard

Inherits:
Object
  • Object
show all
Defined in:
lib/cyberSource_client/models/v2payments_payment_information_card.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V2paymentsPaymentInformationCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 91

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

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

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

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

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

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

Instance Attribute Details

#account_encoder_id ⇒ Object

Identifier for the issuing bank that provided the customer’s encoded account number. Contact your processor for the bank’s ID.



42
43
44
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 42

def 
  @account_encoder_id
end

#expiration_month ⇒ Object

Two-digit month in which the credit card expires. ‘Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (type=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



21
22
23
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 21

def expiration_month
  @expiration_month
end

#expiration_year ⇒ Object

Four-digit year in which the credit card expires. ‘Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (type=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field 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_client/models/v2payments_payment_information_card.rb', line 24

def expiration_year
  @expiration_year
end

#issue_number ⇒ Object

Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. The issue number is not required for Maestro (UK Domestic) transactions.



45
46
47
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 45

def issue_number
  @issue_number
end

#number ⇒ Object

Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



18
19
20
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 18

def number
  @number
end

#security_code ⇒ Object

Card Verification Number.



36
37
38
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 36

def security_code
  @security_code
end

#security_code_indicator ⇒ Object

Flag that indicates whether a CVN code was sent. Possible values: - 0 (default): CVN service not requested. CyberSource uses this default value when you do not include securityCode in the request. - 1 (default): CVN service requested and supported. CyberSource uses this default value when you include securityCode in the request. - 2: CVN on credit card is illegible. - 9: CVN was not imprinted on credit card.



39
40
41
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 39

def security_code_indicator
  @security_code_indicator
end

#source_account_type ⇒ Object

Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases. - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for CTV. Note Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - CHECKING: Checking account - CREDIT: Credit card account - SAVING: Saving account - LINE_OF_CREDIT: Line of credit - PREPAID: Prepaid card account - UNIVERSAL: Universal account



33
34
35
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 33

def 
  @source_account_type
end

#start_month ⇒ Object

Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. ‘Format: MM`. Possible values: 01 through 12. The start date is not required for Maestro (UK Domestic) transactions.



48
49
50
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 48

def start_month
  @start_month
end

#start_year ⇒ Object

Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. ‘Format: YYYY`. The start date is not required for Maestro (UK Domestic) transactions.



51
52
53
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 51

def start_year
  @start_year
end

#type ⇒ Object

Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover



27
28
29
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 27

def type
  @type
end

#use_as ⇒ Object

Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. Cielo and **Comercio Latino** Possible values: - CREDIT: Credit card - DEBIT: Debit card This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet.



30
31
32
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 30

def use_as
  @use_as
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
68
69
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 54

def self.attribute_map
  {
    :'number' => :'number',
    :'expiration_month' => :'expirationMonth',
    :'expiration_year' => :'expirationYear',
    :'type' => :'type',
    :'use_as' => :'useAs',
    :'source_account_type' => :'sourceAccountType',
    :'security_code' => :'securityCode',
    :'security_code_indicator' => :'securityCodeIndicator',
    :'account_encoder_id' => :'accountEncoderId',
    :'issue_number' => :'issueNumber',
    :'start_month' => :'startMonth',
    :'start_year' => :'startYear'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 72

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 341

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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 394

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



460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 460

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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 373

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


360
361
362
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 360

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



366
367
368
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 366

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



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
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
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 148

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

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

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

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

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

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

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

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

  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



440
441
442
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 440

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



446
447
448
449
450
451
452
453
454
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 446

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



434
435
436
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 434

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/cyberSource_client/models/v2payments_payment_information_card.rb', line 203

def valid?
  return false if !@number.nil? && @number.to_s.length > 20
  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 !@type.nil? && @type.to_s.length > 3
  return false if !@use_as.nil? && @use_as.to_s.length > 2
  return false if !@source_account_type.nil? && @source_account_type.to_s.length > 2
  return false if !@security_code.nil? && @security_code.to_s.length > 4
  return false if !@security_code_indicator.nil? && @security_code_indicator.to_s.length > 1
  return false if !@account_encoder_id.nil? && @account_encoder_id.to_s.length > 3
  return false if !@issue_number.nil? && @issue_number.to_s.length > 5
  return false if !@start_month.nil? && @start_month.to_s.length > 2
  return false if !@start_year.nil? && @start_year.to_s.length > 4
  true
end