class CyberSource::Ptsv2paymentsPointOfSaleInformation

Attributes

amex_capn_data[RW]

Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. For details, see `auth_pos_data` field description in [Credit Card Services Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/)

cardholder_verification_method[RW]

Complete list of cardholder verification methods (CVMs) supported by the terminal. Optional field. Possible values: - `PIN` - `Signature` EXAMPLE: ["PIN","Signature"] NOTE: You can submit one of the values or both of the above in a request. For authorizations and credits, this field is only supported on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX

cat_level[RW]

Type of cardholder-activated terminal. Possible values: - 1: Automated dispensing machine - 2: Self-service terminal - 3: Limited amount terminal - 4: In-flight commerce (IFC) terminal - 5: Radio frequency device - 6: Mobile acceptance terminal - 7: Electronic cash register - 8: E-commerce device at your location - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network #### Chase Paymentech Solutions Only values 1, 2, and 3 are supported. Required if `pointOfSaleInformation.terminalID` is included in the request; otherwise, optional. #### CyberSource through VisaNet Values 1 through 6 are supported on CyberSource through VisaNet, but some acquirers do not support all six values. Optional field. #### FDC Nashville Global Only values 7, 8, and 9 are supported. Optional field for EMV transactions; otherwise, not used. #### GPN Only values 6, 7, 8, and 9 are supported. Required field. #### JCN Gateway Only values 6, 7, 8, and 9 are supported. Required field. #### TSYS Acquiring Solutions Only value 6 is supported. Required for transactions from mobile devices; otherwise, not used. #### All other processors Not used. Nonnegative integer.

device_id[RW]

Value created by the client software that uniquely identifies the POS device. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX.

emv[RW]
emv_application_identifier_and_dedicated_file_name[RW]

This 32 byte length-maximum EBCDIC-K value is used to identify which chip application was performed between the terminal and the chip product. The included values are the Application Identifier (AID) and the Dedicated File (DF) name. It is available to early- or full-option VSDC issuers. Only single byte Katakana characters that can map to the EBCDIC-K table expected in the name.

encrypted_key_serial_number[RW]

Combination of the device's unique identifier and a transaction counter that is used in the process of decrypting the encrypted PIN. The entity that injected the PIN encryption keys into the terminal decrypts the encrypted PIN and creates this value. For all terminals that are using derived unique key per transaction (DUKPT) encryption, this is generated as a single number within the terminal. #### Used by **Authorization, PIN Debit** - Required when the cardholder enters a PIN and the card cannot verify the PIN, which means that the issuer must verify the PIN. - Required for PIN debit credit or PIN debit purchase. - Required for online PIN transactions For authorizations, this field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX This field is also used by processors that support chip and online PIN transactions. The following table lists the EMV Cards and Cardholder Verification Methods (CVMs) that these processors support: | Processor | Chip and Offline PIN | Chip and Online PIN | Chip and Signature | | — | — | — | — | | American Express Direct | Yes | Yes | Yes | | Chase Paymentech Solutions | No | No | Yes | | Credit Mutuel-CIC | Yes | Yes | Yes | | CyberSource through VisaNet | Yes | No | Yes | | FDC Nashville Global | Yes | Yes | Yes | | GPN | No | No | Yes | | OmniPay Direct | Yes | No | Yes | | SIX | Yes | Yes | Yes |

encrypted_pin[RW]

Encrypted PIN. This value is provided by the client software that is installed on the POS terminal. #### Used by **Authorization, PIN Debit** Required when the cardholder enters a PIN and the card cannot verify the PIN, which means that the issuer must verify the PIN. Required for PIN debit credit or PIN debit purchase. Required for online PIN transactions. For authorizations, this field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX This field is also used by processors that support chip and online PIN transactions. The following table lists the EMV Cards and Cardholder Verification Methods (CVMs) that these processors support: | Processor | Chip and Offline PIN | Chip and Online PIN | Chip and Signature | | — | — | — | — | | American Express Direct | Yes | Yes | Yes | | Chase Paymentech Solutions | No | No | Yes | | Credit Mutuel-CIC | Yes | Yes | Yes | | CyberSource through VisaNet | Yes | No | Yes | | FDC Nashville Global | Yes | Yes | Yes | | GPN | No | No | Yes | | OmniPay Direct | Yes | No | Yes | | SIX | Yes | Yes | Yes |

entry_mode[RW]

Method of entering payment card information into the POS terminal. Possible values: - `contact`: Read from direct contact with chip card. - `contactless`: Read from a contactless interface using chip data. - `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. - `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. - `swiped`: Read from credit card magnetic stripe. The `contact`, `contactless`, and `msd` values are supported only for EMV transactions. #### Used by Authorization Required field. #### Card Present Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. #### PIN debit Required for a PIN debit purchase and a PIN debit credit request.

is_dedicated_hardware_terminal[RW]

Type of mPOS device. Possible values: - 0: Dongle - 1: Phone or tablet This optional field is supported only for Mastercard transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 141 - Field: Mastercard mPOS Transaction The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks.

lane_number[RW]

Identifier for an alternate terminal at your retail location. You define the value for this field. This field is supported only for MasterCard transactions on FDC Nashville Global. Otherwise, this field is not used by all other processors. Use the `terminalId` field to identify the main terminal at your retail location. If your retail location has multiple terminals, use this `laneNumber` field to identify the terminal used for the transaction. This field is a pass-through, which means that the value is not checked or modified in any way before sending it to the processor. Optional field. #### Card present reply messaging Identifier for an alternate terminal at your retail location. You defined the value for this field in the request message. This value must be printed on the receipt. This field is supported only for MasterCard transactions on FDC Nashville Global.

operating_environment[RW]

Operating environment. Possible values for all card types except Mastercard: - `0`: No terminal used or unknown environment. - `1`: On merchant premises, attended. - `2`: On merchant premises, unattended. Examples: oil, kiosks, self-checkout, mobile telephone, personal digital assistant (PDA). - `3`: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in taxis. - `4`: Off merchant premises, unattended. Examples: vending machines, home computer, mobile telephone, PDA. - `5`: On premises of cardholder, unattended. - `9`: Unknown delivery mode. - `S`: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the internet. - `T`: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier. #### Possible values for Mastercard: - `2`: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for Mastercard transactions on CyberSource through VisaNet. - `4`: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer, mobile telephone, PDA. Cardholder terminal is supported only for Mastercard transactions on CyberSource through VisaNet. This field is supported only for American Express Direct and CyberSource through VisaNet.

partner_sdk_version[RW]

Version of the software installed on the POS terminal. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. For authorizations and credits, this field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX

pin_block_encoding_format[RW]

Format that is used to encode the PIN block. This value is provided by the client software that is installed on the POS terminal. Possible values: - `0`: ISO 9564 format 0 - `1`: ISO 9564 format 1 - `2`: ISO 9564 format 2 - `3`: ISO 9564 format 3 #### Used by **Authorization, PIN Debit** - Required when the cardholder enters a PIN and the card cannot verify the PIN, which means that the issuer must verify the PIN. - Required for PIN debit credit or PIN debit purchase. For authorizations, this field is supported only on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX This field is also supported by processors that support chip and online PIN transactions. The following table lists the EMV Cards and Cardholder Verification Methods (CVMs) that these processors support: | Processor | Chip and Offline PIN | Chip and Online PIN | Chip and Signature | | — | — | — | — | | American Express Direct | Yes | Yes | Yes | | Chase Paymentech Solutions | No | No | Yes | | Credit Mutuel-CIC | Yes | Yes | Yes | | CyberSource through VisaNet | Yes | No | Yes | | FDC Nashville Global | Yes | Yes | Yes | | GPN | No | No | Yes | | OmniPay Direct | Yes | No | Yes | | SIX | Yes | Yes | Yes | #### GPX For chip and online PIN transactions for authorization, GPX supports the following EMV Cards and Cardholder Verification Methods (CVMs): - Chip and Offline PIN - Chip and Signature For PIN Debit Purchase and Credit Service transactions, GPX supports the following EMV Cards and Cardholder Verification Methods (CVMs): - Chip and Online PIN

store_and_forward_indicator[RW]

When connectivity is unavailable, the client software that is installed on the POS terminal can store a transaction in its memory and send it for authorization when connectivity is restored. This value is provided by the client software that is installed on the POS terminal. This value is not forwarded to the processor. Instead, the value is forwarded to the reporting functionality. Possible values: - `Y`: Transaction was stored and then forwarded. - `N` (default): Transaction was not stored and then forwarded. For authorizations and credits, this field is supported only on these processors: - American Express Direct - FDC Nashville Global - OmniPay Direct - SIX Optional field.

terminal_capability[RW]

POS terminal’s capability. Possible values: - `1`: Terminal has a magnetic stripe reader only. - `2`: Terminal has a magnetic stripe reader and manual entry capability. - `3`: Terminal has manual entry capability only. - `4`: Terminal can read chip cards. - `5`: Terminal can read contactless chip cards; cannot use contact to read chip cards. For an EMV transaction, the value of this field must be `4` or `5`. #### PIN debit Required for PIN debit purchase and PIN debit credit request. #### Used by Authorization Required for the following processors: - American Express Direct - Chase Paymentech Solutions - Credit Mutuel-CIC - FDC Nashville Global - FDMS Nashville - OmniPay Direct - SIX - Worldpay VAP Optional for the following processors: - CyberSource through VisaNet - GPN - GPX - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions

terminal_card_capture_capability[RW]

Indicates whether the terminal can capture the card. Possible values: - `1`: Terminal can capture card. - `0`: Terminal cannot capture card. For authorizations and credits, this field is supported only by these processors: - American Express Direct - Credit Mutuel-CIC - OmniPay Direct Optional field.

terminal_compliance[RW]

Flag that indicates whether the terminal is compliant with standards mandated by the Reserve Bank of India for card-present domestic transactions in India. Format: - First character indicates whether the terminal supports terminal line encryption (TLE). Possible values: - 1: Not certified - 2: Certified - Second character indicates whether the terminal supports Unique Key Per Transaction (UKPT) and Derived Unique Key Per Transaction (DUKPT). Possible values: - 1: Not certified - 2: Certified Example `21` indicates that the terminal supports TLE but does not support UKPT/DUKPT. You and the terminal vendors are responsible for terminal certification. If you have questions, contact your acquirer. This field is supported only for Mastercard transactions on CyberSource through VisaNet. Note On CyberSource through VisaNet, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 92-93 - Field: Mastercard Terminal Compliance Indicator The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. #### Used by Authorization Required for card-present transactions in India. Otherwise, not used.

terminal_id[RW]

Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource through VisaNet A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. When you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by Authorization Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt.

terminal_input_capability[RW]

Complete list of card input methods supported by the terminal. Possible values: - `Keyed`: Terminal can accept card data that is entered manually. - `Swiped`: Terminal can accept card data from a magnetic stripe reader. - `Contact`: Terminal can accept card data in EMV contact mode ("dipping a card"). - `Contactless`: Terminal can accept card data in EMV contactless mode ("tapping a card"). - `BarCode`: Terminal can read bar codes. - `QRcode`: Terminal can read or scan QR codes. - `OCR`: Terminal can perform optical character recognition (OCT) on the card. EXAMPLE: ["Keyed","Swiped","Contact","Contactless"] #### Used by **Authorization and Credit** Optional. This field is supported only by client software that is installed on your POS terminals for the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX

terminal_make[RW]

This is the manufacturer name of the reader which is used to accept the payment. Possible values: - PAX - Verifone - Ingenico

terminal_model[RW]

This is the model name of the reader which is used to accept the payment. Possible values: - E3555 - P400 - A920

terminal_output_capability[RW]

Indicates whether the terminal can print or display messages. Possible values: - 1: Neither - 2: Print only - 3: Display only - 4: Print and display This field is supported for authorizations and credits only on the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field.

terminal_pin_capability[RW]

Maximum PIN length that the terminal can capture. Possible values: - 0: No PIN capture capability - 1: PIN capture capability unknown - 4: Four characters - 5: Five characters - 6: Six characters - 7: Seven characters - 8: Eight characters - 9: Nine characters - 10: Ten characters - 11: Eleven characters - 12: Twelve characters This field is supported for authorizations and credits only on the following processors: - American Express Direct - Credit Mutuel-CIC - OmniPay Direct - SIX Required field for authorization or credit of PIN transactions.

terminal_serial_number[RW]

Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. This value is not forwarded to the processor. Instead, the value is forwarded to the reporting functionality. #### Used by **Authorization and Credit** Optional. This field is supported only by client software that is installed on your POS terminals for the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX

track_data[RW]

Card’s track 1 and 2 data. For all processors except FDMS Nashville, this value consists of one of the following: - Track 1 data - Track 2 data - Data for both tracks 1 and 2 For FDMS Nashville, this value consists of one of the following: - Track 1 data - Data for both tracks 1 and 2 Example: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000? #### Used by Authorization Required for Chase Paymentech Solutions, Credit Mutuel-CIC, CyberSource through VisaNet, FDC Nashville Global, JCN Gateway, OmniPay Direct, and SIX if `pointOfSaleInformation.entryMode` is equal to one of these values: - `contact` - `contactless` - `msd` - `swiped` Otherwise, this field not used. Required for all other processors if `pointOfSaleInformation.entryMode=swiped`; otherwise, this field is not used. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### PIN debit Track 2 data from the debit card. The sentinels are required. Required field for a PIN debit purchase and a PIN debit credit.

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_point_of_sale_information.rb, line 95
def self.attribute_map
  {
    :'terminal_id' => :'terminalId',
    :'terminal_serial_number' => :'terminalSerialNumber',
    :'lane_number' => :'laneNumber',
    :'cat_level' => :'catLevel',
    :'entry_mode' => :'entryMode',
    :'terminal_capability' => :'terminalCapability',
    :'operating_environment' => :'operatingEnvironment',
    :'emv' => :'emv',
    :'amex_capn_data' => :'amexCapnData',
    :'track_data' => :'trackData',
    :'store_and_forward_indicator' => :'storeAndForwardIndicator',
    :'cardholder_verification_method' => :'cardholderVerificationMethod',
    :'terminal_input_capability' => :'terminalInputCapability',
    :'terminal_card_capture_capability' => :'terminalCardCaptureCapability',
    :'terminal_output_capability' => :'terminalOutputCapability',
    :'terminal_pin_capability' => :'terminalPinCapability',
    :'device_id' => :'deviceId',
    :'pin_block_encoding_format' => :'pinBlockEncodingFormat',
    :'encrypted_pin' => :'encryptedPin',
    :'encrypted_key_serial_number' => :'encryptedKeySerialNumber',
    :'partner_sdk_version' => :'partnerSdkVersion',
    :'emv_application_identifier_and_dedicated_file_name' => :'emvApplicationIdentifierAndDedicatedFileName',
    :'terminal_compliance' => :'terminalCompliance',
    :'is_dedicated_hardware_terminal' => :'isDedicatedHardwareTerminal',
    :'terminal_model' => :'terminalModel',
    :'terminal_make' => :'terminalMake'
  }
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_point_of_sale_information.rb, line 160
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?(:'terminalId')
    self.terminal_id = attributes[:'terminalId']
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'cardholderVerificationMethod')
    if (value = attributes[:'cardholderVerificationMethod']).is_a?(Array)
      self.cardholder_verification_method = value
    end
  end

  if attributes.has_key?(:'terminalInputCapability')
    if (value = attributes[:'terminalInputCapability']).is_a?(Array)
      self.terminal_input_capability = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'terminalMake')
    self.terminal_make = attributes[:'terminalMake']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 127
def self.swagger_types
  {
    :'terminal_id' => :'String',
    :'terminal_serial_number' => :'String',
    :'lane_number' => :'String',
    :'cat_level' => :'Integer',
    :'entry_mode' => :'String',
    :'terminal_capability' => :'Integer',
    :'operating_environment' => :'String',
    :'emv' => :'Ptsv2paymentsPointOfSaleInformationEmv',
    :'amex_capn_data' => :'String',
    :'track_data' => :'String',
    :'store_and_forward_indicator' => :'String',
    :'cardholder_verification_method' => :'Array<String>',
    :'terminal_input_capability' => :'Array<String>',
    :'terminal_card_capture_capability' => :'String',
    :'terminal_output_capability' => :'String',
    :'terminal_pin_capability' => :'Integer',
    :'device_id' => :'String',
    :'pin_block_encoding_format' => :'Integer',
    :'encrypted_pin' => :'String',
    :'encrypted_key_serial_number' => :'String',
    :'partner_sdk_version' => :'String',
    :'emv_application_identifier_and_dedicated_file_name' => :'String',
    :'terminal_compliance' => :'String',
    :'is_dedicated_hardware_terminal' => :'String',
    :'terminal_model' => :'String',
    :'terminal_make' => :'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_point_of_sale_information.rb, line 461
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      terminal_id == o.terminal_id &&
      terminal_serial_number == o.terminal_serial_number &&
      lane_number == o.lane_number &&
      cat_level == o.cat_level &&
      entry_mode == o.entry_mode &&
      terminal_capability == o.terminal_capability &&
      operating_environment == o.operating_environment &&
      emv == o.emv &&
      amex_capn_data == o.amex_capn_data &&
      track_data == o.track_data &&
      store_and_forward_indicator == o.store_and_forward_indicator &&
      cardholder_verification_method == o.cardholder_verification_method &&
      terminal_input_capability == o.terminal_input_capability &&
      terminal_card_capture_capability == o.terminal_card_capture_capability &&
      terminal_output_capability == o.terminal_output_capability &&
      terminal_pin_capability == o.terminal_pin_capability &&
      device_id == o.device_id &&
      pin_block_encoding_format == o.pin_block_encoding_format &&
      encrypted_pin == o.encrypted_pin &&
      encrypted_key_serial_number == o.encrypted_key_serial_number &&
      partner_sdk_version == o.partner_sdk_version &&
      emv_application_identifier_and_dedicated_file_name == o.emv_application_identifier_and_dedicated_file_name &&
      terminal_compliance == o.terminal_compliance &&
      is_dedicated_hardware_terminal == o.is_dedicated_hardware_terminal &&
      terminal_model == o.terminal_model &&
      terminal_make == o.terminal_make
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_point_of_sale_information.rb, line 528
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_point_of_sale_information.rb, line 594
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
amex_capn_data=(amex_capn_data) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 373
def amex_capn_data=(amex_capn_data)
  @amex_capn_data = amex_capn_data
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_point_of_sale_information.rb, line 507
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
cat_level=(cat_level) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 333
def cat_level=(cat_level)
  if !cat_level.nil? && cat_level > 9
    fail ArgumentError, 'invalid value for "cat_level", must be smaller than or equal to 9.'
  end

  if !cat_level.nil? && cat_level < 1
    fail ArgumentError, 'invalid value for "cat_level", must be greater than or equal to 1.'
  end

  @cat_level = cat_level
end
device_id=(device_id) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 397
def device_id=(device_id)
  @device_id = device_id
end
emv_application_identifier_and_dedicated_file_name=(emv_application_identifier_and_dedicated_file_name) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 431
def emv_application_identifier_and_dedicated_file_name=(emv_application_identifier_and_dedicated_file_name)
  @emv_application_identifier_and_dedicated_file_name = emv_application_identifier_and_dedicated_file_name
end
encrypted_key_serial_number=(encrypted_key_serial_number) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 419
def encrypted_key_serial_number=(encrypted_key_serial_number)
  @encrypted_key_serial_number = encrypted_key_serial_number
end
encrypted_pin=(encrypted_pin) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 413
def encrypted_pin=(encrypted_pin)
  @encrypted_pin = encrypted_pin
end
entry_mode=(entry_mode) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 347
def entry_mode=(entry_mode)
  @entry_mode = entry_mode
end
eql?(o) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 494
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 500
def hash
  [terminal_id, terminal_serial_number, lane_number, cat_level, entry_mode, terminal_capability, operating_environment, emv, amex_capn_data, track_data, store_and_forward_indicator, cardholder_verification_method, terminal_input_capability, terminal_card_capture_capability, terminal_output_capability, terminal_pin_capability, device_id, pin_block_encoding_format, encrypted_pin, encrypted_key_serial_number, partner_sdk_version, emv_application_identifier_and_dedicated_file_name, terminal_compliance, is_dedicated_hardware_terminal, terminal_model, terminal_make].hash
end
is_dedicated_hardware_terminal=(is_dedicated_hardware_terminal) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 443
def is_dedicated_hardware_terminal=(is_dedicated_hardware_terminal)
  @is_dedicated_hardware_terminal = is_dedicated_hardware_terminal
end
lane_number=(lane_number) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 327
def lane_number=(lane_number)
  @lane_number = lane_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_point_of_sale_information.rb, line 277
def list_invalid_properties
  invalid_properties = Array.new
  if !@cat_level.nil? && @cat_level > 9
    invalid_properties.push('invalid value for "cat_level", must be smaller than or equal to 9.')
  end

  if !@cat_level.nil? && @cat_level < 1
    invalid_properties.push('invalid value for "cat_level", must be greater than or equal to 1.')
  end

  if !@terminal_capability.nil? && @terminal_capability > 5
    invalid_properties.push('invalid value for "terminal_capability", must be smaller than or equal to 5.')
  end

  if !@terminal_capability.nil? && @terminal_capability < 1
    invalid_properties.push('invalid value for "terminal_capability", must be greater than or equal to 1.')
  end

  if !@pin_block_encoding_format.nil? && @pin_block_encoding_format > 9
    invalid_properties.push('invalid value for "pin_block_encoding_format", must be smaller than or equal to 9.')
  end

  invalid_properties
end
operating_environment=(operating_environment) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 367
def operating_environment=(operating_environment)
  @operating_environment = operating_environment
end
partner_sdk_version=(partner_sdk_version) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 425
def partner_sdk_version=(partner_sdk_version)
  @partner_sdk_version = partner_sdk_version
end
pin_block_encoding_format=(pin_block_encoding_format) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 403
def pin_block_encoding_format=(pin_block_encoding_format)
  if !pin_block_encoding_format.nil? && pin_block_encoding_format > 9
    fail ArgumentError, 'invalid value for "pin_block_encoding_format", must be smaller than or equal to 9.'
  end

  @pin_block_encoding_format = pin_block_encoding_format
end
store_and_forward_indicator=(store_and_forward_indicator) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 379
def store_and_forward_indicator=(store_and_forward_indicator)
  @store_and_forward_indicator = store_and_forward_indicator
end
terminal_capability=(terminal_capability) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 353
def terminal_capability=(terminal_capability)
  if !terminal_capability.nil? && terminal_capability > 5
    fail ArgumentError, 'invalid value for "terminal_capability", must be smaller than or equal to 5.'
  end

  if !terminal_capability.nil? && terminal_capability < 1
    fail ArgumentError, 'invalid value for "terminal_capability", must be greater than or equal to 1.'
  end

  @terminal_capability = terminal_capability
end
terminal_card_capture_capability=(terminal_card_capture_capability) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 385
def terminal_card_capture_capability=(terminal_card_capture_capability)
  @terminal_card_capture_capability = terminal_card_capture_capability
end
terminal_compliance=(terminal_compliance) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 437
def terminal_compliance=(terminal_compliance)
  @terminal_compliance = terminal_compliance
end
terminal_id=(terminal_id) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 315
def terminal_id=(terminal_id)
  @terminal_id = terminal_id
end
terminal_make=(terminal_make) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 455
def terminal_make=(terminal_make)
  @terminal_make = terminal_make
end
terminal_model=(terminal_model) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 449
def terminal_model=(terminal_model)
  @terminal_model = terminal_model
end
terminal_output_capability=(terminal_output_capability) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 391
def terminal_output_capability=(terminal_output_capability)
  @terminal_output_capability = terminal_output_capability
end
terminal_serial_number=(terminal_serial_number) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb, line 321
def terminal_serial_number=(terminal_serial_number)
  @terminal_serial_number = terminal_serial_number
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_point_of_sale_information.rb, line 574
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_point_of_sale_information.rb, line 580
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_point_of_sale_information.rb, line 568
def to_s
  to_hash.to_s
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_point_of_sale_information.rb, line 304
def valid?
  return false if !@cat_level.nil? && @cat_level > 9
  return false if !@cat_level.nil? && @cat_level < 1
  return false if !@terminal_capability.nil? && @terminal_capability > 5
  return false if !@terminal_capability.nil? && @terminal_capability < 1
  return false if !@pin_block_encoding_format.nil? && @pin_block_encoding_format > 9
  true
end