Class: CyberSource::Ptsv2paymentsPaymentInformationCard

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsPaymentInformationCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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



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

def 
  @account_encoder_id
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.



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

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.



24
25
26
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_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. Note The issue number is not required for Maestro (UK Domestic) transactions.



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

def issue_number
  @issue_number
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. #### FDMS Nashville Required. String (19) #### GPX 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. #### 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.



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

def number
  @number
end

#product_name ⇒ Object

Name of the card product. Possible value: - BNDES This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 115-120 - Field: Brazil Country Data



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

def product_name
  @product_name
end

#security_code ⇒ Object

Card Verification Number. #### FDMS Nashville Required for American Express or if swiped; otherwise, optional. #### Ingenico ePayments Do not include this field when ‘commerceIndicator=recurring`. Note Ingenico ePayments was previously called _Global Collect_. #### TSYS Acquiring Solutions Optional if pointOfSaleInformation.entryMode=keyed; otherwise, not used. #### GPX Optional. #### All other processors: Optional.



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

def security_code
  @security_code
end

#security_code_indicator ⇒ Object

Indicates whether a CVN code was sent. Possible values: - ‘0` (default): CVN service not requested. This default value is used when you do not include `securityCode` field in the request. - `1` (default): CVN service requested and supported. This default value is used when you include `securityCode` field in the request. - `2`: CVN on credit card is illegible. - `9`: CVN was not imprinted on credit card. #### FDMS Nashville Required for American Express cards; otherwise, optional. #### TSYS Acquiring Solutions Optional if `pointOfSaleInformation.entryMode=keyed`; otherwise, not used. #### All other processors Optional.



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

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 CyberSource through VisaNet (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 or credit portion of combo card - `PREPAID`: Prepaid card account or prepaid portion of combo card - `UNIVERSAL`: Universal account



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

def 
  @source_account_type
end

#source_account_type_details ⇒ Object

Type of account that is being used when the value for the override_payment_method field is line of credit (LI) or prepaid card (PP). Possible values for line of credit: - ‘AGRC`: Visa Agro Custeio - `AGRE`: Visa Agro Electron - `AGRI`: Visa Agro Investimento - `AGRO`: Visa Agro Possible values for prepaid card: - `VVA`: Visa Vale Alimentacao - `VVF`: Visa Vale Flex - `VVR`: Visa Vale Refeicao This field is supported only for combo card transactions in Brazil on CyberSource through VisaNet.



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

def 
  @source_account_type_details
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.



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

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.



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

def start_year
  @start_year
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



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

def type
  @type
end

#type_selection_indicator ⇒ Object

Flag that identifies how the card type was selected. Possible values: - 0: Card type was selected based on default acquirer settings. - 1: Customer selected the card type.



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

def type_selection_indicator
  @type_selection_indicator
end

#use_as ⇒ Object

Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. Possible values: - C: Credit transaction - D: Debit transaction This field is supported only for all card Types on Visa Platform Connect. This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. Note The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 51 - Field: Combination Card Transaction Identifier



30
31
32
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_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.



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/ptsv2payments_payment_information_card.rb', line 63

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

.json_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 84

def self.json_map
  {
    :'number' => :'number',
    :'expiration_month' => :'expiration_month',
    :'expiration_year' => :'expiration_year',
    :'type' => :'type',
    :'use_as' => :'use_as',
    :'source_account_type' => :'source_account_type',
    :'source_account_type_details' => :'source_account_type_details',
    :'security_code' => :'security_code',
    :'security_code_indicator' => :'security_code_indicator',
    :'account_encoder_id' => :'account_encoder_id',
    :'issue_number' => :'issue_number',
    :'start_month' => :'start_month',
    :'start_year' => :'start_year',
    :'product_name' => :'product_name',
    :'type_selection_indicator' => :'type_selection_indicator'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 105

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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/ptsv2payments_payment_information_card.rb', line 293

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. &&
       == 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 &&
      product_name == o.product_name &&
      type_selection_indicator == o.type_selection_indicator
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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 349

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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 415

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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 328

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


315
316
317
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 315

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



321
322
323
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 321

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



196
197
198
199
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 196

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



395
396
397
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 395

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



401
402
403
404
405
406
407
408
409
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 401

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



389
390
391
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb', line 389

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

def valid?
  true
end