class CyberSource::Ptsv2paymentsPaymentInformationCard

Attributes

account_encoder_id[RW]

Identifier for the issuing bank that provided the customer’s encoded account number. Contact your processor for the bank’s ID.

expiration_month[RW]

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.

expiration_year[RW]

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.

issue_number[RW]

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.

number[RW]

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.

product_name[RW]

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

security_code[RW]

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.

security_code_indicator[RW]

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.

source_account_type[RW]

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

source_account_type_details[RW]

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.

start_month[RW]

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.

start_year[RW]

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.

type[RW]

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 [^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

use_as[RW]

Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. #### Cielo and Comercio Latino Possible values: - CREDIT: Credit card - DEBIT: Debit card 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 This field is supported only for Mastercard transactions in Brazil on CyberSource through VisaNet.

Public Class Methods

attribute_map() click to toggle source

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

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

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 101
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.source_account_type = attributes[:'sourceAccountType']
  end

  if attributes.has_key?(:'sourceAccountTypeDetails')
    self.source_account_type_details = 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.account_encoder_id = 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
end
swagger_types() click to toggle source

Attribute type mapping.

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

Public Instance Methods

==(o) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 257
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 &&
      source_account_type == o.source_account_type &&
      source_account_type_details == o.source_account_type_details &&
      security_code == o.security_code &&
      security_code_indicator == o.security_code_indicator &&
      account_encoder_id == o.account_encoder_id &&
      issue_number == o.issue_number &&
      start_month == o.start_month &&
      start_year == o.start_year &&
      product_name == o.product_name
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_rest_client/models/ptsv2payments_payment_information_card.rb, line 312
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_rest_client/models/ptsv2payments_payment_information_card.rb, line 378
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
account_encoder_id=(account_encoder_id) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 227
def account_encoder_id=(account_encoder_id)
  @account_encoder_id = account_encoder_id
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_rest_client/models/ptsv2payments_payment_information_card.rb, line 291
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
eql?(o) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 278
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_rest_client/models/ptsv2payments_payment_information_card.rb, line 185
def expiration_month=(expiration_month)
  @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_rest_client/models/ptsv2payments_payment_information_card.rb, line 191
def expiration_year=(expiration_year)
  @expiration_year = expiration_year
end
hash() click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 284
def hash
  [number, expiration_month, expiration_year, type, use_as, source_account_type, source_account_type_details, security_code, security_code_indicator, account_encoder_id, issue_number, start_month, start_year, product_name].hash
end
issue_number=(issue_number) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 233
def issue_number=(issue_number)
  @issue_number = issue_number
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_rest_client/models/ptsv2payments_payment_information_card.rb, line 166
def list_invalid_properties
  invalid_properties = Array.new
  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_rest_client/models/ptsv2payments_payment_information_card.rb, line 179
def number=(number)
  @number = number
end
product_name=(product_name) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 251
def product_name=(product_name)
  @product_name = product_name
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_rest_client/models/ptsv2payments_payment_information_card.rb, line 215
def security_code=(security_code)
  @security_code = security_code
end
security_code_indicator=(security_code_indicator) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 221
def security_code_indicator=(security_code_indicator)
  @security_code_indicator = security_code_indicator
end
source_account_type=(source_account_type) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 203
def source_account_type=(source_account_type)
  @source_account_type = source_account_type
end
source_account_type_details=(source_account_type_details) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 209
def source_account_type_details=(source_account_type_details)
  @source_account_type_details = source_account_type_details
end
start_month=(start_month) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 239
def start_month=(start_month)
  @start_month = start_month
end
start_year=(start_year) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 245
def start_year=(start_year)
  @start_year = start_year
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_rest_client/models/ptsv2payments_payment_information_card.rb, line 358
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_rest_client/models/ptsv2payments_payment_information_card.rb, line 364
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_rest_client/models/ptsv2payments_payment_information_card.rb, line 352
def to_s
  to_hash.to_s
end
use_as=(use_as) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_payment_information_card.rb, line 197
def use_as=(use_as)
  @use_as = use_as
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_rest_client/models/ptsv2payments_payment_information_card.rb, line 173
def valid?
  true
end