Class: CyberSource::TssV2TransactionsGet200ResponsePaymentInformationCard

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TssV2TransactionsGet200ResponsePaymentInformationCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 108

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

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

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

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

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

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

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

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

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



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

def 
  @account_encoder_id
end

#brand_name ⇒ Object

This field contains the card brand name. Some of the possible values (not an exhaustive list) are - - VISA - MASTERCARD - AMERICAN EXPRESS - DISCOVER - DINERS CLUB - CARTE BLANCHE - JCB - OPTIMA - TWINPAY CREDIT CARD - TWINPAY DEBIT CARD - WALMART - ENROUTE - LOWES CONSUMER - HOME DEPOT CONSUMER - MBNA - DICKS SPORTWEAR - CASUAL CORNER - SEARS - JAL - DISNEY CARD - SWITCH/SOLO - SAMS CLUB CONSUMER - SAMS CLUB BUSINESS - NICOS HOUSE CARD - BEBE - RESTORATION HARDWARE - DELTA ONLINE - SOLO - VISA ELECTRON - DANKORT - LASER - CARTE BANCAIRE - CARTA SI - ENCODED ACCOUNT - UATP - HOUSEHOLD - MAESTRO - GE CAPITAL - KOREAN CARDS - STYLE CARDS - JCREW - MEIJER - HIPERCARD - AURA - REDECARD - ORICO HOUSE CARD - ELO - CAPITAL ONE PRIVATE LABEL - CARNET - RUPAY - CHINA UNION PAY - FALABELLA PRIVATE LABEL - PROMPTCARD - KOREAN DOMESTIC - BANRICOMPRAS



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

def brand_name
  @brand_name
end

#currency ⇒ Object

This field indicates the 3-letter [ISO Standard Currency Codes](apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.



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

def currency
  @currency
end

#expiration_month ⇒ Object

Two-digit month in which the payment card expires. Format: ‘MM`. Valid values: `01` through `12`. Leading 0 is required. #### 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`. #### FDMS Nashville Required field. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response.



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

def expiration_month
  @expiration_month
end

#expiration_year ⇒ Object

Four-digit year in which the payment 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`. #### FDMS Nashville Required field. #### 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. #### All other processors Required if `pointOfSaleInformation.entryMode=keyed`. However, this field is optional if your account is configured for relaxed requirements for address data and expiration date. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response.



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

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. Note The issue number is not required for Maestro (UK Domestic) transactions.



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

def issue_number
  @issue_number
end

#prefix ⇒ Object

Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response.



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

def prefix
  @prefix
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. Note The start date is not required for Maestro (UK Domestic) transactions.



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

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`. Note The start date is not required for Maestro (UK Domestic) transactions.



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

def start_year
  @start_year
end

#suffix ⇒ Object

Last four digits of the cardholder’s account number. This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### PIN debit This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. Returned by PIN debit credit and PIN debit purchase. This field is supported only by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX



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

def suffix
  @suffix
end

#type ⇒ Object

Three-digit value that indicates the card type. IMPORTANT It is strongly recommended that you include the card type field in request messages even if it is optional for your processor and card type. Omitting the card type can cause the transaction to be processed with the wrong card type. Possible values: - ‘001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron. - `002`: Mastercard, Eurocard, which is a European regional brand of Mastercard. - `003`: American Express - `004`: Discover - `005`: Diners Club - `006`: Carte Blanche - `007`: JCB - `014`: Enroute - `021`: JAL - `024`: Maestro (UK Domestic) - `031`: Delta: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types. - `033`: Visa Electron. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types. - `034`: Dankort - `036`: Cartes Bancaires - `037`: Carta Si - `039`: Encoded account number - `040`: UATP - `042`: Maestro (International) - `050`: Hipercard - `051`: Aura - `054`: Elo - `062`: China UnionPay - ’070’: EFTPOS [^1]: For this card type, you must include the ‘paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit. [^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5. [^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. [^4]: For this card type, you must include the `paymentInformation.card.type` in your request for any payer authentication services. #### Used by Authorization Required for Carte Blanche and JCB. Optional for all other card types. #### Card Present reply This field is included in the reply message when the client software that is installed on the POS terminal uses the token management service (TMS) to retrieve tokenized payment details. You must contact customer support to have your account enabled to receive these fields in the credit reply message. Returned by the Credit service. This reply field is only supported by the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX #### Google Pay transactions For PAN-based Google Pay transactions, this field is returned in the API response. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International



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

def type
  @type
end

#use_as ⇒ Object

Flag that specifies the type of account associated with the card. This field is available only for China UnionPay, Cielo, Comercio Latino and Visa Platform Connect. The cardholder provides this information during the payment process. This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. **China UnionPayCard Transactions on China UnionPay:** Possible values: - C: Domestic credit card - D: Domestic debit card - F: International credit card - I: International debit card When the value is D, the e-commerce indicator and CAVV fields must be included in the authorization request. When the value is C, F or I the card verification number, expiration month and expiration year fields must in included in the authorization request. **Cielo and Comercio Latino Credit Card Transactions:** On these processors, this field is supported only for authorizations. Possible values: - CR: Credit card - DB: Debit card **Visa Platform Connect Credit Card Transactions:** This field is supported for all card types on Visa Platform Connect. For combo **card present** transactions with Mastercard on Brazilian-issued cards, possible values: - CR: Credit card - DB: Debit Card For combo **card not present** transactions with Mastercard on Brazilian-issued cards, possible values: - C: Credit card - D: Debit card A value of CR or DB in the useAs field takes precedence over any value in the Source Account Type field.



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

def use_as
  @use_as
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 53

def self.attribute_map
  {
    :'suffix' => :'suffix',
    :'prefix' => :'prefix',
    :'expiration_month' => :'expirationMonth',
    :'expiration_year' => :'expirationYear',
    :'start_month' => :'startMonth',
    :'start_year' => :'startYear',
    :'issue_number' => :'issueNumber',
    :'type' => :'type',
    :'brand_name' => :'brandName',
    :'currency' => :'currency',
    :'account_encoder_id' => :'accountEncoderId',
    :'use_as' => :'useAs'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'suffix' => :'suffix',
    :'prefix' => :'prefix',
    :'expiration_month' => :'expiration_month',
    :'expiration_year' => :'expiration_year',
    :'start_month' => :'start_month',
    :'start_year' => :'start_year',
    :'issue_number' => :'issue_number',
    :'type' => :'type',
    :'brand_name' => :'brand_name',
    :'currency' => :'currency',
    :'account_encoder_id' => :'account_encoder_id',
    :'use_as' => :'use_as'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 89

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 232

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 285

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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 351

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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 264

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


251
252
253
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



257
258
259
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 257

def hash
  [suffix, prefix, expiration_month, expiration_year, start_month, start_year, issue_number, type, brand_name, currency, , 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



165
166
167
168
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 165

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



331
332
333
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 331

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



337
338
339
340
341
342
343
344
345
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 337

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



325
326
327
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 325

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



172
173
174
 
# File 'lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_payment_information_card.rb', line 172

def valid?
  true
end