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

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



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
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 144

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?(:'balances')
    if (value = attributes[:'balances']).is_a?(Array)
      self.balances = value
    end
  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 Returned by PIN debit credit or PIN debit purchase. Note This field is returned only for CyberSource through VisaNet.



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

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 #### PIN debit 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 - `40`: Universal account - `96`: Cash benefits account - `98`: Food stamp account Returned by PIN debit purchase.



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

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). Maximum length is 13. #### Chase Paymentech Solutions Maximum length is 1.



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

def affluence_indicator
  @affluence_indicator
end

#balance_amount ⇒ Object

Remaining balance on the account. Returned by authorization service. #### PIN debit Remaining balance on the prepaid card. Returned by PIN debit purchase.



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

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.



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

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: Possible values: - ‘Positive` - `Negative` #### PIN debit Sign for the remaining balance on the prepaid card. Returned only when the processor returns this value. Returned by PIN debit purchase.



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

def balance_sign
  @balance_sign
end

#balances ⇒ Object

This is an array of multiple balances information an issuer can return for a given card.



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

def balances
  @balances
end

#category ⇒ Object

#### GPX Mastercard product ID associated with the primary account number (PAN). Returned by authorization service. #### CyberSource through VisaNet Visa or Mastercard product ID that is associated with the primary account number (PAN). For descriptions of the Visa product IDs, see the Product ID table on the [Visa Request & Response Codes web page.](developer.visa.com/guides/request_response_codes) Data Length: String (3) #### GPN Visa or Mastercard product ID that is associated with the primary account number (PAN). For descriptions of the Visa product IDs, see the Product ID table on the [Visa Request & Response Codes web page.](developer.visa.com/guides/request_response_codes) Data Length: String (3) #### Worldpay VAP Important Before using this field on Worldpay VAP, you must contact CyberSource Customer Support to have your account configured for this feature. Type of card used in the transaction. The only possible value is: - ‘PREPAID`: Prepaid Card Data Length: String (7) #### 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 Data Length: String (1)



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

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



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

def commercial
  @commercial
end

#currency ⇒ Object

Currency of the remaining balance on the account. For the possible values, see the [ISO Standard Currency Codes.](apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) Returned by authorization service. #### PIN debit Currency of the remaining balance on the prepaid card. Returned by PIN debit purchase.



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

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 Returned by authorization service.



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

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



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

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



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

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



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

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



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

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



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

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 - `N`: No - `X`: Not applicable / Unknown



68
69
70
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 68

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



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

def signature_debit
  @signature_debit
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 71

def self.attribute_map
  {
    :'account_type' => :'accountType',
    :'account_status' => :'accountStatus',
    :'balances' => :'balances',
    :'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

.json_map ⇒ Object

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 95

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

.swagger_types ⇒ Object

Attribute type mapping.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 119

def self.swagger_types
  {
    :'account_type' => :'String',
    :'account_status' => :'String',
    :'balances' => :'Array<PtsV2PaymentsPost201ResponsePaymentInformationAccountFeaturesBalances>',
    :'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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 342

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      balances == o.balances &&
      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



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
431
432
433
434
435
436
437
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 401

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



467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 467

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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 380

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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


367
368
369
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 367

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



373
374
375
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 373

def hash
  [, , balances, 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



227
228
229
230
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 227

def list_invalid_properties
  invalid_properties = Array.new
  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



447
448
449
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 447

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



453
454
455
456
457
458
459
460
461
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 453

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



441
442
443
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 441

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



234
235
236
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_payment_information_account_features.rb', line 234

def valid?
  true
end