class CyberSource::V2paymentsPaymentInformationTokenizedCard

Attributes

assurance_level[RW]

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**.

cryptogram[RW]

This field is used internally.

expiration_month[RW]

Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.

expiration_year[RW]

Four-digit year in which the payment network token expires. `Format: YYYY`.

number[RW]

Customer’s payment network token value.

requestor_id[RW]

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**.

security_code[RW]

CVN.

storage_method[RW]

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**.

transaction_type[RW]

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. Set the value for this field to 1. An application on the customer’s mobile device provided the token data.

type[RW]

Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 48
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'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 81
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
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 64
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'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_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 &&
      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
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 344
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 410
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
assurance_level=(assurance_level) click to toggle source

Custom attribute writer method with validation @param [Object] assurance_level Value to be assigned

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 263
def assurance_level=(assurance_level)
  if !assurance_level.nil? && assurance_level.to_s.length > 2
    fail ArgumentError, 'invalid value for "assurance_level", the character length must be smaller than or equal to 2.'
  end

  @assurance_level = assurance_level
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 323
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
cryptogram=(cryptogram) click to toggle source

Custom attribute writer method with validation @param [Object] cryptogram Value to be assigned

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 233
def cryptogram=(cryptogram)
  if !cryptogram.nil? && cryptogram.to_s.length > 40
    fail ArgumentError, 'invalid value for "cryptogram", the character length must be smaller than or equal to 40.'
  end

  @cryptogram = cryptogram
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 310
def eql?(o)
  self == o
end
expiration_month=(expiration_month) click to toggle source

Custom attribute writer method with validation @param [Object] expiration_month Value to be assigned

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 203
def expiration_month=(expiration_month)
  if !expiration_month.nil? && expiration_month.to_s.length > 2
    fail ArgumentError, 'invalid value for "expiration_month", the character length must be smaller than or equal to 2.'
  end

  @expiration_month = expiration_month
end
expiration_year=(expiration_year) click to toggle source

Custom attribute writer method with validation @param [Object] expiration_year Value to be assigned

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 213
def expiration_year=(expiration_year)
  if !expiration_year.nil? && expiration_year.to_s.length > 4
    fail ArgumentError, 'invalid value for "expiration_year", the character length must be smaller than or equal to 4.'
  end

  @expiration_year = expiration_year
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 316
def hash
  [number, expiration_month, expiration_year, type, cryptogram, requestor_id, transaction_type, assurance_level, storage_method, security_code].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 130
def list_invalid_properties
  invalid_properties = Array.new
  if !@number.nil? && @number.to_s.length > 20
    invalid_properties.push('invalid value for "number", the character length must be smaller than or equal to 20.')
  end

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

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

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

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

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

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

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

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

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

  invalid_properties
end
number=(number) click to toggle source

Custom attribute writer method with validation @param [Object] number Value to be assigned

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 193
def number=(number)
  if !number.nil? && number.to_s.length > 20
    fail ArgumentError, 'invalid value for "number", the character length must be smaller than or equal to 20.'
  end

  @number = number
end
requestor_id=(requestor_id) click to toggle source

Custom attribute writer method with validation @param [Object] requestor_id Value to be assigned

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 243
def requestor_id=(requestor_id)
  if !requestor_id.nil? && requestor_id.to_s.length > 11
    fail ArgumentError, 'invalid value for "requestor_id", the character length must be smaller than or equal to 11.'
  end

  @requestor_id = requestor_id
end
security_code=(security_code) click to toggle source

Custom attribute writer method with validation @param [Object] security_code Value to be assigned

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 283
def security_code=(security_code)
  if !security_code.nil? && security_code.to_s.length > 4
    fail ArgumentError, 'invalid value for "security_code", the character length must be smaller than or equal to 4.'
  end

  @security_code = security_code
end
storage_method=(storage_method) click to toggle source

Custom attribute writer method with validation @param [Object] storage_method Value to be assigned

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 273
def storage_method=(storage_method)
  if !storage_method.nil? && storage_method.to_s.length > 3
    fail ArgumentError, 'invalid value for "storage_method", the character length must be smaller than or equal to 3.'
  end

  @storage_method = storage_method
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 390
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 396
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 384
def to_s
  to_hash.to_s
end
transaction_type=(transaction_type) click to toggle source

Custom attribute writer method with validation @param [Object] transaction_type Value to be assigned

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 253
def transaction_type=(transaction_type)
  if !transaction_type.nil? && transaction_type.to_s.length > 1
    fail ArgumentError, 'invalid value for "transaction_type", the character length must be smaller than or equal to 1.'
  end

  @transaction_type = transaction_type
end
type=(type) click to toggle source

Custom attribute writer method with validation @param [Object] type Value to be assigned

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 223
def type=(type)
  if !type.nil? && type.to_s.length > 3
    fail ArgumentError, 'invalid value for "type", the character length must be smaller than or equal to 3.'
  end

  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cyberSource_client/models/v2payments_payment_information_tokenized_card.rb, line 177
def valid?
  return false if !@number.nil? && @number.to_s.length > 20
  return false if !@expiration_month.nil? && @expiration_month.to_s.length > 2
  return false if !@expiration_year.nil? && @expiration_year.to_s.length > 4
  return false if !@type.nil? && @type.to_s.length > 3
  return false if !@cryptogram.nil? && @cryptogram.to_s.length > 40
  return false if !@requestor_id.nil? && @requestor_id.to_s.length > 11
  return false if !@transaction_type.nil? && @transaction_type.to_s.length > 1
  return false if !@assurance_level.nil? && @assurance_level.to_s.length > 2
  return false if !@storage_method.nil? && @storage_method.to_s.length > 3
  return false if !@security_code.nil? && @security_code.to_s.length > 4
  true
end