Class: CyberSource::Ptsv2paymentsPointOfSaleInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsPointOfSaleInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
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
335
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 210

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?(:'cardholderVerificationMethodUsed')
    self.cardholder_verification_method_used = attributes[:'cardholderVerificationMethodUsed']
  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?(:'pinEntrySolution')
    self.pin_entry_solution = attributes[:'pinEntrySolution']
  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

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

Instance Attribute Details

#amex_capn_data ⇒ Object

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/)



44
45
46
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 44

def amex_capn_data
  @amex_capn_data
end

#cardholder_verification_method ⇒ Object

Complete list of cardholder verification methods (CVMs) supported by the terminal. Optional field. Possible values: - ‘PIN`: For terminals with a PIN Pad - `Signature`: For terminals capable of receiving a signature - `pinOnGlass`: For terminals where PIN is entered on a glass-based capture mechanism EXAMPLE: ["PIN","Signature"]; ["pinOnGlass","Signature"]



53
54
55
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 53

def cardholder_verification_method
  @cardholder_verification_method
end

#cardholder_verification_method_used ⇒ Object

Method that was used to verify the cardholder’s identity. Possible values: - ‘0`: No verification - `1`: Signature - `2`: PIN - `3`: Cardholder device CVM



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

def cardholder_verification_method_used
  @cardholder_verification_method_used
end

#cat_level ⇒ Object

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.



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

def cat_level
  @cat_level
end

#device_id ⇒ Object

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.



71
72
73
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 71

def device_id
  @device_id
end

#emv ⇒ Object

Returns the value of attribute emv.



41
42
43
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 41

def emv
  @emv
end

#emv_application_identifier_and_dedicated_file_name ⇒ Object

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.



86
87
88
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 86

def emv_application_identifier_and_dedicated_file_name
  @emv_application_identifier_and_dedicated_file_name
end

#encrypted_key_serial_number ⇒ Object

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 |



80
81
82
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 80

def encrypted_key_serial_number
  @encrypted_key_serial_number
end

#encrypted_pin ⇒ Object

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 |



77
78
79
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 77

def encrypted_pin
  @encrypted_pin
end

#entry_mode ⇒ Object

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.



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

def entry_mode
  @entry_mode
end

#is_dedicated_hardware_terminal ⇒ Object

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.



92
93
94
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 92

def is_dedicated_hardware_terminal
  @is_dedicated_hardware_terminal
end

#lane_number ⇒ Object

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.



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

def lane_number
  @lane_number
end

#operating_environment ⇒ Object

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.



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

def operating_environment
  @operating_environment
end

#partner_sdk_version ⇒ Object

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



83
84
85
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 83

def partner_sdk_version
  @partner_sdk_version
end

#pin_block_encoding_format ⇒ Object

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



74
75
76
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 74

def pin_block_encoding_format
  @pin_block_encoding_format
end

#pin_entry_solution ⇒ Object

This field will contain the type of Pin Pad the terminal has. Possible values: - PCI-SPoC: Where the pin is being put on screen - PCI-PTS: Where the pin is being put on actual hardware pin pad



68
69
70
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 68

def pin_entry_solution
  @pin_entry_solution
end

#service_code ⇒ Object

#### Visa Platform Connect Mastercard service code that is included in the track data. This field is supported only for Mastercard on Visa Platform Connect. You can extract the service code from the track data and provide it in this API field. When not provided it will be extracted from: - Track2Data for MSR transactions - EMV tag 5F30 for EMV transactions To enable this feature please call support.



101
102
103
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 101

def service_code
  @service_code
end

#store_and_forward_indicator ⇒ Object

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.



50
51
52
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 50

def store_and_forward_indicator
  @store_and_forward_indicator
end

#terminal_capability ⇒ Object

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



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

def terminal_capability
  @terminal_capability
end

#terminal_card_capture_capability ⇒ Object

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.



59
60
61
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 59

def terminal_card_capture_capability
  @terminal_card_capture_capability
end

#terminal_compliance ⇒ Object

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.



89
90
91
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 89

def terminal_compliance
  @terminal_compliance
end

#terminal_id ⇒ Object

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.



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

def terminal_id
  @terminal_id
end

#terminal_input_capability ⇒ Object

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



56
57
58
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 56

def terminal_input_capability
  @terminal_input_capability
end

#terminal_make ⇒ Object

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



98
99
100
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 98

def terminal_make
  @terminal_make
end

#terminal_model ⇒ Object

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



95
96
97
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 95

def terminal_model
  @terminal_model
end

#terminal_output_capability ⇒ Object

Indicates whether the terminal can print or display messages. Possible values: - 1: Neither - 2: Print only - 3: Display only - 4: Print and display - 5: Merchant terminal supports purchase only approvals 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 - VisaNet Optional field.



62
63
64
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 62

def terminal_output_capability
  @terminal_output_capability
end

#terminal_pin_capability ⇒ Object

Maximum PIN length that the terminal can capture. Possible values: - 0: No PIN capture capability - 1: PIN capture capability unknown - 2: PIN Pad down - 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 - Visa Platform Connect Required field for authorization or credit of PIN transactions.



65
66
67
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 65

def terminal_pin_capability
  @terminal_pin_capability
end

#terminal_serial_number ⇒ Object

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



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

def terminal_serial_number
  @terminal_serial_number
end

#track_data ⇒ Object

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.



47
48
49
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 47

def track_data
  @track_data
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
108
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 104

def self.attribute_map
  {
    :'terminal_id' => :'terminalId',
    :'terminal_serial_number' => :'terminalSerialNumber',
    :'cardholder_verification_method_used' => :'cardholderVerificationMethodUsed',
    :'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',
    :'pin_entry_solution' => :'pinEntrySolution',
    :'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',
    :'service_code' => :'serviceCode'
  }
end

.json_map ⇒ Object

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 139

def self.json_map
  {
    :'terminal_id' => :'terminal_id',
    :'terminal_serial_number' => :'terminal_serial_number',
    :'cardholder_verification_method_used' => :'cardholder_verification_method_used',
    :'lane_number' => :'lane_number',
    :'cat_level' => :'cat_level',
    :'entry_mode' => :'entry_mode',
    :'terminal_capability' => :'terminal_capability',
    :'operating_environment' => :'operating_environment',
    :'emv' => :'emv',
    :'amex_capn_data' => :'amex_capn_data',
    :'track_data' => :'track_data',
    :'store_and_forward_indicator' => :'store_and_forward_indicator',
    :'cardholder_verification_method' => :'cardholder_verification_method',
    :'terminal_input_capability' => :'terminal_input_capability',
    :'terminal_card_capture_capability' => :'terminal_card_capture_capability',
    :'terminal_output_capability' => :'terminal_output_capability',
    :'terminal_pin_capability' => :'terminal_pin_capability',
    :'pin_entry_solution' => :'pin_entry_solution',
    :'device_id' => :'device_id',
    :'pin_block_encoding_format' => :'pin_block_encoding_format',
    :'encrypted_pin' => :'encrypted_pin',
    :'encrypted_key_serial_number' => :'encrypted_key_serial_number',
    :'partner_sdk_version' => :'partner_sdk_version',
    :'emv_application_identifier_and_dedicated_file_name' => :'emv_application_identifier_and_dedicated_file_name',
    :'terminal_compliance' => :'terminal_compliance',
    :'is_dedicated_hardware_terminal' => :'is_dedicated_hardware_terminal',
    :'terminal_model' => :'terminal_model',
    :'terminal_make' => :'terminal_make',
    :'service_code' => :'service_code'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 174

def self.swagger_types
  {
    :'terminal_id' => :'String',
    :'terminal_serial_number' => :'String',
    :'cardholder_verification_method_used' => :'Integer',
    :'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',
    :'pin_entry_solution' => :'String',
    :'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',
    :'service_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 484

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      terminal_id == o.terminal_id &&
      terminal_serial_number == o.terminal_serial_number &&
      cardholder_verification_method_used == o.cardholder_verification_method_used &&
      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 &&
      pin_entry_solution == o.pin_entry_solution &&
      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 &&
      service_code == o.service_code
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



554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 554

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



620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 620

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



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 533

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


520
521
522
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 520

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



526
527
528
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 526

def hash
  [terminal_id, terminal_serial_number, cardholder_verification_method_used, 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, pin_entry_solution, 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, service_code].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



339
340
341
342
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 339

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



600
601
602
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 600

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



606
607
608
609
610
611
612
613
614
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 606

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



594
595
596
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 594

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



346
347
348
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_point_of_sale_information.rb', line 346

def valid?
  true
end