Class: CyberSource::Ptsv2paymentsPaymentInformationTokenizedCard

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsPaymentInformationTokenizedCard

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
162
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 109

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

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

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

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

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

Instance Attribute Details

#assurance_level ⇒ Object

Confidence level of the tokenization. This value is assigned by the token service provider. Note This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. Returned by PIN debit credit or PIN debit purchase. Note Merchants supported for **CyberSource through VisaNet**/**Visa Platform Connect** are advised not to use this field.



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

def assurance_level
  @assurance_level
end

#assurance_method ⇒ Object

Confidence level of the tokenization. This value is assigned by the token service provider. Note This field is supported only for **Visa Platform Connect**



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

def assurance_method
  @assurance_method
end

#cryptogram ⇒ Object

This field contains token information.



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

def cryptogram
  @cryptogram
end

#expiration_month ⇒ Object

One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: ‘MM` Possible values: `01` through `12` NOTE The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### 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 (`card_type=039`), if there is no expiration date on the card, use `12`.\ Important It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def expiration_month
  @expiration_month
end

#expiration_year ⇒ Object

One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: ‘YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer NOTE The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### 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 (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### FDC Nashville Global and FDMS South You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)



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

def expiration_year
  @expiration_year
end

#number ⇒ Object

Customer’s payment network token value.



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

def number
  @number
end

#requestor_id ⇒ Object

Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. Note This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. #### PIN debit Optional field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used.



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

def requestor_id
  @requestor_id
end

#security_code ⇒ Object

Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. Note Ingenico ePayments was previously called _Global Collect_. For details, see ‘customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)



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

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.



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

def security_code_indicator
  @security_code_indicator
end

#storage_method ⇒ Object

Type of technology used in the device to store token data. Possible values: - ‘001`: Secure Element (SE). Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment credentials, a SE is tested against a set of requirements defined by the payment networks. Note This field is supported only for _FDC Compass_. - 002: Host Card Emulation (HCE). Emulation of a smart card by using software to create a virtual and exact representation of the card. Sensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database must meet very stringent security requirements that exceed PCI DSS. Note This field is supported only for _FDC Compass_.



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

def storage_method
  @storage_method
end

#transaction_type ⇒ Object

Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Possible value: - ‘2`: Near-field communication (NFC) transaction. The customer’s mobile device provided the token data for a contactless EMV transaction. For recurring transactions, use this value if the original transaction was a contactless EMV transaction. #### Visa Platform Connect - ‘1`: For Rupay and In App tokenization. Example: InApp apple pay. - `3`: Card/Credential On File Tokenization. NOTE No CyberSource through VisaNet acquirers support EMV at this time. Required field for PIN debit credit or PIN debit purchase transactions that use payment network tokens; otherwise, not used. #### Rupay - `3`: Card/Credential On File Tokenization. - `4`: Tokenizined Transaction. Should be used for Guest Checkout transactions with token.



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

def transaction_type
  @transaction_type
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_tokenized_card.rb', line 27

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'number' => :'number',
    :'expiration_month' => :'expirationMonth',
    :'expiration_year' => :'expirationYear',
    :'type' => :'type',
    :'cryptogram' => :'cryptogram',
    :'requestor_id' => :'requestorId',
    :'transaction_type' => :'transactionType',
    :'assurance_level' => :'assuranceLevel',
    :'storage_method' => :'storageMethod',
    :'security_code' => :'securityCode',
    :'security_code_indicator' => :'securityCodeIndicator',
    :'assurance_method' => :'assuranceMethod'
  }
end

.json_map ⇒ Object

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



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

def self.json_map
  {
    :'number' => :'number',
    :'expiration_month' => :'expiration_month',
    :'expiration_year' => :'expiration_year',
    :'type' => :'type',
    :'cryptogram' => :'cryptogram',
    :'requestor_id' => :'requestor_id',
    :'transaction_type' => :'transaction_type',
    :'assurance_level' => :'assurance_level',
    :'storage_method' => :'storage_method',
    :'security_code' => :'security_code',
    :'security_code_indicator' => :'security_code_indicator',
    :'assurance_method' => :'assurance_method'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'number' => :'String',
    :'expiration_month' => :'String',
    :'expiration_year' => :'String',
    :'type' => :'String',
    :'cryptogram' => :'String',
    :'requestor_id' => :'String',
    :'transaction_type' => :'String',
    :'assurance_level' => :'String',
    :'storage_method' => :'String',
    :'security_code' => :'String',
    :'security_code_indicator' => :'String',
    :'assurance_method' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 245

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 &&
      cryptogram == o.cryptogram &&
      requestor_id == o.requestor_id &&
      transaction_type == o.transaction_type &&
      assurance_level == o.assurance_level &&
      storage_method == o.storage_method &&
      security_code == o.security_code &&
      security_code_indicator == o.security_code_indicator &&
      assurance_method == o.assurance_method
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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 298

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 364

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 277

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


264
265
266
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



270
271
272
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 270

def hash
  [number, expiration_month, expiration_year, type, cryptogram, requestor_id, transaction_type, assurance_level, storage_method, security_code, security_code_indicator, assurance_method].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



166
167
168
169
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 166

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



344
345
346
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 344

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



350
351
352
353
354
355
356
357
358
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 350

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



338
339
340
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 338

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



173
174
175
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_payment_information_tokenized_card.rb', line 173

def valid?
  true
end