Class: CyberSource::PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 138

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_status ⇒ Object

Possible values: - N: Nonregulated - R: Regulated ‘Note` This field is returned only for CyberSource through VisaNet.



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

def 
  @account_status
end

#account_type ⇒ Object

Type of account. This value is returned only if you requested a balance inquiry. Possible values: - 00: Not applicable or not specified - 10: Savings account - 20: Checking account - 30: Credit card account - 40: Universal account



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

def 
  @account_type
end

#affluence_indicator ⇒ Object

**Chase Paymentech Solutions** Indicates whether a customer has high credit limits. This information enables you to market high cost items to these customers and to understand the kinds of cards that high income customers are using. This field is supported for Visa, Mastercard, Discover, and Diners Club. Possible values: - Y: Yes - N: No - X: Not applicable / Unknown Litle Flag that indicates that a Visa cardholder or Mastercard cardholder is in one of the affluent categories. Possible values: - AFFLUENT: High income customer with high spending pattern (>100k USD annual income and >40k USD annual card usage). - **MASS AFFLUENT**: High income customer (>100k USD annual income). **Processor specific maximum length**: - Chase Paymentech Solutions: 1 - Litle: 13



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

def affluence_indicator
  @affluence_indicator
end

#balance_amount ⇒ Object

Remaining balance on the account.



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

def balance_amount
  @balance_amount
end

#balance_amount_type ⇒ Object

Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value that is returned. Possible values for deposit accounts: - 01: Current ledger (posted) balance. - 02: Current available balance, which is typically the ledger balance less outstanding authorizations. Some depository institutions also include pending deposits and the credit or overdraft line associated with the account. Possible values for credit card accounts: - 01: Credit amount remaining for customer (open to buy). - 02: Credit limit.



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

def balance_amount_type
  @balance_amount_type
end

#balance_sign ⇒ Object

Sign for the remaining balance on the account. Returned only when the processor returns this value. Possible values:



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

def balance_sign
  @balance_sign
end

#category ⇒ Object

**CyberSource through VisaNet** Visa product ID. GPN Visa or Mastercard product ID. Litle Type of card used in the transaction. The only possible value is: - PREPAID: Prepaid Card **RBS WorldPay Atlanta** Type of card used in the transaction. Possible values: - B: Business Card - O: Noncommercial Card - R: Corporate Card - S: Purchase Card - Blank: Purchase card not supported **Maximum length for processors**: - CyberSource through VisaNet: 3 - GPN: 3 - Litle: 7 - RBS WorldPay Atlanta: 1



39
40
41
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 39

def category
  @category
end

#commercial ⇒ Object

Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - Y: Yes - N: No - X: Not applicable / Unknown



42
43
44
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 42

def commercial
  @commercial
end

#currency ⇒ Object

Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes.



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

def currency
  @currency
end

#group ⇒ Object

Type of commercial card. This field is supported only for CyberSource through VisaNet. Possible values: - B: Business card - R: Corporate card - S: Purchasing card - 0: Noncommercial card



45
46
47
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 45

def group
  @group
end

#health_care ⇒ Object

Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - Y: Yes - N: No - X: Not applicable / Unknown



48
49
50
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 48

def health_care
  @health_care
end

#level3_eligible ⇒ Object

Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III data in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - Y: Yes - N: No - X: Not applicable / Unknown



54
55
56
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 54

def level3_eligible
  @level3_eligible
end

#payroll ⇒ Object

Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB on **Chase Paymentech Solutions**. Possible values: - Y: Yes - N: No - X: Not applicable / Unknown



51
52
53
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 51

def payroll
  @payroll
end

#pinless_debit ⇒ Object

Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - Y: Yes - N: No - X: Not applicable / Unknown



57
58
59
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 57

def pinless_debit
  @pinless_debit
end

#prepaid ⇒ Object

Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or prepaid card is presented for use when establishing a new recurring, installment, or deferred billing relationship. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - Y: Yes - N: No - X: Not applicable / Unknown



63
64
65
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 63

def prepaid
  @prepaid
end

#regulated ⇒ Object

Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card issuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - Y: Yes (assets greater than 10B USD) - N: No (assets less than 10B USD) - X: Not applicable / Unknown



66
67
68
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 66

def regulated
  @regulated
end

#signature_debit ⇒ Object

Indicates whether the card is a signature debit card. This information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might want to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and Maestro (International) on Chase Paymentech Solutions. Possible values: - Y: Yes - N: No - X: Not applicable / Unknown



60
61
62
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 60

def signature_debit
  @signature_debit
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 91

def self.attribute_map
  {
    :'account_type' => :'accountType',
    :'account_status' => :'accountStatus',
    :'balance_amount' => :'balanceAmount',
    :'balance_amount_type' => :'balanceAmountType',
    :'currency' => :'currency',
    :'balance_sign' => :'balanceSign',
    :'affluence_indicator' => :'affluenceIndicator',
    :'category' => :'category',
    :'commercial' => :'commercial',
    :'group' => :'group',
    :'health_care' => :'healthCare',
    :'payroll' => :'payroll',
    :'level3_eligible' => :'level3Eligible',
    :'pinless_debit' => :'pinlessDebit',
    :'signature_debit' => :'signatureDebit',
    :'prepaid' => :'prepaid',
    :'regulated' => :'regulated'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 114

def self.swagger_types
  {
    :'account_type' => :'String',
    :'account_status' => :'String',
    :'balance_amount' => :'String',
    :'balance_amount_type' => :'String',
    :'currency' => :'String',
    :'balance_sign' => :'String',
    :'affluence_indicator' => :'String',
    :'category' => :'String',
    :'commercial' => :'String',
    :'group' => :'String',
    :'health_care' => :'String',
    :'payroll' => :'String',
    :'level3_eligible' => :'String',
    :'pinless_debit' => :'String',
    :'signature_debit' => :'String',
    :'prepaid' => :'String',
    :'regulated' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 485

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      balance_amount == o.balance_amount &&
      balance_amount_type == o.balance_amount_type &&
      currency == o.currency &&
      balance_sign == o.balance_sign &&
      affluence_indicator == o.affluence_indicator &&
      category == o.category &&
      commercial == o.commercial &&
      group == o.group &&
      health_care == o.health_care &&
      payroll == o.payroll &&
      level3_eligible == o.level3_eligible &&
      pinless_debit == o.pinless_debit &&
      signature_debit == o.signature_debit &&
      prepaid == o.prepaid &&
      regulated == o.regulated
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



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 543

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



609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 609

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



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 522

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


509
510
511
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 509

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



515
516
517
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 515

def hash
  [, , balance_amount, balance_amount_type, currency, balance_sign, affluence_indicator, category, commercial, group, health_care, payroll, level3_eligible, pinless_debit, signature_debit, prepaid, regulated].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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
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
282
283
284
285
286
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 215

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



589
590
591
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 589

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



595
596
597
598
599
600
601
602
603
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 595

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



583
584
585
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 583

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 290

def valid?
  return false if !@account_type.nil? && @account_type.to_s.length > 2
  return false if !@account_status.nil? && @account_status.to_s.length > 1
  return false if !@balance_amount.nil? && @balance_amount.to_s.length > 12
  return false if !@balance_amount_type.nil? && @balance_amount_type.to_s.length > 2
  return false if !@currency.nil? && @currency.to_s.length > 5
  balance_sign_validator = EnumAttributeValidator.new('String', ['+', '-'])
  return false unless balance_sign_validator.valid?(@balance_sign)
  return false if !@balance_sign.nil? && @balance_sign.to_s.length > 1
  return false if !@affluence_indicator.nil? && @affluence_indicator.to_s.length > 13
  return false if !@category.nil? && @category.to_s.length > 7
  return false if !@commercial.nil? && @commercial.to_s.length > 1
  return false if !@group.nil? && @group.to_s.length > 1
  return false if !@health_care.nil? && @health_care.to_s.length > 1
  return false if !@payroll.nil? && @payroll.to_s.length > 1
  return false if !@level3_eligible.nil? && @level3_eligible.to_s.length > 1
  return false if !@pinless_debit.nil? && @pinless_debit.to_s.length > 1
  return false if !@signature_debit.nil? && @signature_debit.to_s.length > 1
  return false if !@prepaid.nil? && @prepaid.to_s.length > 1
  return false if !@regulated.nil? && @regulated.to_s.length > 1
  true
end