SCA Functional Specification

• Y – Yes
• N – No

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – DCC transactions will be approved offline (SAF) in local currency.
• 1 – DCC transactions will be approved offline (SAF) in foreign currency.

• 0 – Disable
• 1 – Enable

• 0 - Disable
• 1 - Enable

• 0 – Disable
• 1 – Enable

• 0 - Disabled
• 1 - Enabled

Numeric, 4

• Max - 500 milliseconds
• Min - 5000 milliseconds

• 0 – Retail
• 1 – Restaurant
• 2 – Cat Type

• 0 – Parameter downloaded from VHQ will be updated on when application receives APPLYUPDATES command from POS.
• 1 – Parameter downloaded from VHQ will be updated immediately.

• 0 - Disable
• 1 - Enable

• 0 - Disable
• 1 - Enable

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – None
• 1 – Zip code
• 2 – Address
• 3 – Both (Zip code + Address)

This parameter is used to enable or disable the AVS prompting for the transaction types. SCA application displays AVS prompt only for Sale (Capture), Authorization and Card Validation transactions with payment type Credit. AVSTRANSTYPES parameter will function accordingly, when AVSMODE and PROMPTAVSFORALL parameters are NOT set to 0. AVSTRANSTYPES parameter contains one byte value per each transactions in a sequence from left to right. In 10 bytes field, each byte denotes if the AVS prompt is enabled or disabled for that transaction type.

• Byte 1 - Sale
• Byte 2 - Authorization
• Byte 3 - Card Validation
• Byte 4 to 10 - Reserved for future use.

• Byte value 0 - AVS prompt is disabled for the transaction type.
• Byte value 1 - AVS prompt is enabled for the transaction type.

• 0 - Disabled
• 1 - Enabled

• Y - Yes
• N - No

Alphabetic,

• ibeacon
• eddystone

• 0 – Disable
• 1 – Enable

• 0 – Application prompts for number of card to activate.
• 1 – Application will ask to swipe the last card in the sequence.

• 0 - Disabled
• 1 - Enabled

• 0 - Do not prompt for unpair confirmation screen when Enter+5 is pressed on idle screen.
• 1 - Prompt for unpair confirmation screen when Enter+5 is pressed on idle screen.

• 0 - Disable
• 1 – Enable

Valid values:

• -1 (Existing color)
• FF0000 (Red)
• 00FF00 (Green)
• 0000FF (Blue)
• 000000 (Black)

• y - Yes
• n - No

• 0 – None
• 1 – Prompt
• 2 – Log on

• 0 – Do not print
• 1 – Print
• 2 – Prompt

• 0 - Disabled
• 1 - Enabled

• 0 – Disable
• 1 – Enable

• 0 - Disabled
• 1 - Enabled

Valid values:

• -1 (Existing color)
• FF0000 (Red)
• 00FF00 (Green)
• 0000FF (Blue)
• 000000 (Black)

Valid values:

• -1 (Existing color)
• FF0000 (Red)
• 00FF00 (Green)
• 0000FF (Blue)
• 000000 (Black)

• 0 - Disable
• 1 - Enable

Numeric, 2

Value ranges: 0 - 15

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• Y – Enable
• N – Disable

• Y – Yes
• N – No

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – Do not disable CTLS
• 1 – Disable CTLS

• 0 - Disabled
• 1 - Enabled

• 0 - Send the PINLESS DEBIT conversion request flag during SAF forward of the eligible CREDIT request.
• 1 - Do not send the PINLESS DEBIT conversion request flag during SAF forward of the eligible CREDIT request.

• 0 – Disable
• 1 – Enable

• Y – Yes
• N – No

Numeric, 2

0 – 99 seconds

• 0 – Disable
• 1 – Enable

• 0 - Access Freely/No Password Required
• 1 - Custom/Host specific
• 2 - Manager password required
• 3 - Supervisor password required
• 4 - Clerk password required

• 0 – Disable
• 1 – Enable

• 0 - Disabled
• 1 - Enabled

• Y - Yes
• N - No

• 0 - Disabled
• 1 - Enabled

• Y - Yes
• N - No

• Y - Yes
• N - No

• Y - Yes
• N - No

• 0 - Disabled
• 1 - Enabled for full batch
• 2 - Enable for Last Transaction only

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable and embossed Account Number calculation will be done by application.
• 2 – Enable and embossed Account Number will be requested in the host request packet.
  NOTE: Value 2 is applicable for PWC only.

• 0 - Disable
• 1 - Enable

• 0 – No batch empty error message, performs settlement after printing report.
• 1 – Replies batch empty error message, without printing the reports.

• 0 – Disable
• 1 – Enable

• 0 - No password prompt will appear.
• 1 - Password prompt during clerk addition.

• 0 – Disable
• 1 – Enable

Numeric, 1

• 0 - Regular Balance
• 1 - Full EMV
• 2 - Partial EMV

• 0 – Disable
• 1 – Enable

• aesdukpt
• eparms
• None

• NOE
• VSP
• VSD
• TRA

Alphanumeric, 42

Example: FBPYMTTYPES=CREDIT-DEBIT-PRIV_LBL-GIFT

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 - Disable
• 1 - Enable

• 0 - Disabled
• 1 - Enabled

• 0 - Disabled
• 1 - Enabled

• 0 - Disabled
• 1 - Enabled
• 2 - Resyncing CCP profiles (eth0 and wlan0)

Numeric, 4

• 0 - Disable
• -1 - Retry infinite times.
• Value > 0 - Retry for that configured value.

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – Disable. Does not prompt CVV for Manual Entry Gift transactions.
• 1 – Enable. Prompts CVV for Manual Entry Gift transactions.

• 0 - Disabled
• 1 - Cashout enabled
• 2 - Auto cashout enabled

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 - Disables Gift PIN prompt
• 1 - Prompts Gift PIN for manual, swiped, and MSD Gift transactions, unless PINENTRYALLOWED (with underscore _) is set to N for the particular BIN range.

• 2 - Prompts Gift PIN for manual Gift transactions only, unless PINENTRYALLOWED (with underscore _) is set to N for the particular BIN range.

  NOTE: Currently Gift PIN is not prompted for account passthrough and token based Gift transactions.

• 0 - Disables Gift PIN bypass
• 1 - Enables Gift PIN bypass

Numeric, Valid Values: 1 to 12

NOTE: Any number other than the valid value, will set to the default value 4.

• 0 - PIN_CODE field will not be sent back to the POS in POS response.
• 1 - PIN_CODE field will be sent back to the POS in POS response.

• 0 – Disable
• 1 – Enable

• 0 - Do not Send Events to GDA
• 1 - Send Events to GDA

This parameter is used to set the list of commands excluded from the diagnostics Event Types ApplicationException and AppAbruptRestarts. The list of commands should be presented as separated by pipe (|).

Example: |LOYALTY|CUST_QUESTION|DISPLAY_MESSAGE|

These commands will be excluded from generating Diagnostic events messages to avoid false alarms like, if the command is used and kept running while the device is in Idle status.

Alphanumeric

Maximum length - 50

Format: |command Name1|command Name2|

• 0 – Disable
• 1 – Enable

• n – Disabled
• y – Enabled

• 0 - Image
• 1 - Animation
• 2 - Video

Numeric

• 1 - Device Serial number
• 2 - IP Address
• 4 - BT MAC Address of the device.
• 8 - WIFI MAC
• 16 - ETH MAC Address of the device.

• 0 (Infinite time)
• 10 seconds to 60 seconds
• Maximum value: 600 seconds. If the value is over 600 seconds, then it is automatically set to 600 seconds.

Numeric, 3

Value range: 5 - 999

• 0 - Disable
• 1 - Enable

• 0 - Disable
• 1 - Enable

This parameter is used to enable or disable keyboard lock feature.

NOTE:
- If lockkeyboard is enabled, then it will prompt for the supervisor password.
- If lockkeyboard is enabled and transaction password level is set to higher than the supervisor, then it will prompt password based on the password level. And if it is lesser than the supervisor, then it will prompt for the default one that is supervisor.

• 0 - Disables Keyboard Lock feature.
• 1 - Enables Keyboard Lock feature

• en – English
• es – Spanish
• fr – French
• de - German
• ru - Russian
• pt - Portuguese
• it - Italian

• RETAIL
• RESTAURANT
• LAUNCHSCAIDLE
• BANKING
• PATT

Alphanumeric, 6

• (Red) FF0000
• (Green) 00FF00
• (Blue) 0000FF
• (Black) 000000

• 0 – Disable
• 1 – Enable

• 0 - Image
• 1 - Animation

• 0 - Image
• 1 - Animation

• 0 – Disable
• 1 – Enable

Numeric, 1

• 0 - NO MAC
• 1 - MSK MAC
• 2 - DUKPT MAC

This parameter is used to enable or disable the prompt for zip code for credit card transactions where MANUAL_ENTRY is set to TRUE.

• If this parameter is enabled, then it is recommended to set PROMPTAVSFORALL and AVSMODE parameters to 0.
• Sending MANUAL_PROMPT_OPTIONS field in POS request may override this parameter functionality.

• 0 – Disable the prompt for zip code
• 1 – Enable the prompt for zip code

• 0 – Do not print
• 1 – Print

• 0 – Disable
• 1 – Enable

• 0 – Application will not prompt for expiry date.
• 1 – Application will prompt for expiry date.

• 0 - Disabled
• 1 - Enabled

• 0 – Does not allow negative batch settlement (both auto and manual)
• 1 – Allows negative batch settlement (both auto and manual)
• 2 – Does not allow negative batch settlement during auto settlement. Allows negative batch settlement during manual settlement.

• 1
• Default value for Chase: 0

This parameter is used to set the password level to enable negative batch settlement.

• If the password level is custom (1), then the custom password defined in the configuration will be used.
• If the password level is other than custom, then the password hierarchy applies.

• 0 – Access Freely/No Password required
• 1 – Custom/Host specific
• 2 – Manager password required
• 3 – Supervisor password required
• 4 – Clerk password required

• 0 - Allows alphanumeric values
• 1 - Allows numeric values

• C – Capture
• N – None

• TCP
• SERIAL
• WEBSOCKETS
• NONE

• 0 – Enable
• 1 – Disable printing

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• 0 - Payment type prompt will not come for Canada solutions, even if card falls in multiple BIN ranges. The first matched record will be considered.
• 1 - Payment type prompt will come for Canada solutions, if card falls in multiple BIN ranges.

• 0 - Disabled
• 1 - Enabled

• 0 – Prints for both Merchant and Customer receipts.
• 1 – Prints for Merchant Copy receipt only.
• 2 – Prints for Customer Copy receipt only.
• 3 – Do not print cardholder’s name on the receipts.

• 0 - Disabled
• 1 - Enabled

• 0 - Disabled
• 1 - Enabled

• 0 - Both Merchant and Customer
• 1 - Merchant Copy Only
• 2 - Customer Copy Only
• 3 - Do not print

• 0 - Both Merchant and Customer
• 1 - Merchant Copy Only
• 2 - Customer Copy Only
• 3 - Do not print

• 0
• 3 (Worldpay Petro)

• 0 - Both Merchant and Customer
• 1 - Merchant Copy Only
• 2 - Customer Copy Only
• 3 - Do not print

• 0
• 3 (Worldpay Petro)

• 0 - Disabled
• 1 - Enabled

• 0 - Disabled
• 1 - Enabled

• 0 (Canada device)
• 1 (US device)

• 0 - Does not print the line item data on the receipt.
• 1 - Prints the line item data on the receipt.

• 0 - Printer – Receipt prints on device
• 1 - Auto – Receipt data prints on printer, if available. If not, prints on ECR.
• 2 - Buffered – Receipt data sent to ECR
• 3 - Both – Receipt data prints on device and POS

• 0 - Do not print
• 1 - Print
• 2 - Prompt

• 0 - Does not return response text
• 1 - Returns response text

• 0 – Disable
• 1 – Enable

• 0 - Disable
• 1 - Enable

• 0 - Disable
• 1 - Enable

• 0 - Disabled
• 1 - Enabled

• 0 - Sentinels will not be removed from track data.
• 1 - Sentinels will be removed from track data.

• n - No
• y - Yes

Numeric, 1

• 0 – Cardholder’s name is not returned in POS response.
• 1 – Cardholder’s name is returned in POS response.
• 2 - Cardholder’s name is masked in POS response.

• 0 – Disable
• 1 – Enable

• EOS
• LOGSYS
• ADK
• NONE

• 0 – Send back response after internal transaction completion.
• 1 – Send back response parallel to transaction completion.

• 1
• 0 (for UGP)

• N – Disable
• Y – Enable

• n – Disable
• y – Enable

• 0 – Disable
• 1 – Enable

• 0 – None
• 1 – Automatic
• 2 – Manual

• 0 – Disable
• 1 – Enable

• 0 – Amount confirmation option will be displayed on the device.
• 1 – Amount confirmation option will not be displayed on the device.

• 0 – Uses the amount for duplicate check.
• 1 – Does not use the amount for duplicate check.

• 0 – No
• 1 – Yes

• N – Disable
• Y – Enable

• 0 – Disable
• 1 – Enable

• 0 - Disabled
• 1 - Enabled

• 0 - Does not calculate and return the Performance Metrics.
• 1 - Calculate and return Performance Metric in POS Response and send to GDA if GDA events are enabled.

• 0 - Disable
• en - English
• fr - French
• es - Espanol

• Summary
• Detail
• Both

• 0 - Disabled
• 1 - Enabled

• BMP
• TIFF
• 3BA
• PNG
• RAW

• 0 - Disabled
• 1 - Enabled

• 0 - Disabled
• 1 - Enabled

• None – Disabled
• Transaction – All Debit Transactions
• Cashback – Only Debit Cashback transactions

• 0 - Disabled
• 1 - Enabled

• 0 - Attended
• 1 - Un-Attended

• PROMPT - Prompts on the device for Tip.
• NOPROMPT - Would not prompt Tip, however, accept Tip values from POS request.
• NONE - Neither accept from POS nor prompt for Tip on the device.

This parameter is used to allow prompting Tip, printing Signature line and Tip line on the receipt for the transaction types. TIPTRANSTYPES parameter contains one byte value per each transaction in a sequence from left to right. In 10 bytes field, each byte denotes if the transaction type is set to the required value for prompting tip or printing the tip and signature line on the receipt.

• Byte 1 - Sale
• Byte 2 - Refund
• Byte 3 - Auth
• Byte 4 - Completion
• Byte 5 - Open Tab
• Byte 6 - Close Tab
• Byte 7 - Force
• Byte 8 - 10 reserved for future use. For Example, if Custom Tip is 201000000, then it indicates that application needs to print tip line on receipt along with signature for Sale transaction, however for Pre-Authorization, it should only print the tip line on the receipt (if TIP prompt is bypassed on the screen).

0 - Does not prompt for Tip or print Tip Line on the receipt.

1 - Prompts for Tip or Prints Tip Line on the receipt.

2 - Prompts for Tip or Prints Tip Line and Signature line on the receipt.

NOTE: For the value 1 and 2, the parameter behavior depends on the following conditions:

• If TIP=PROMPT, then a prompt will appear on screen and if TIP prompt is bypassed or No tip is selected then empty tip line will be printed on the receipt.
• If TIP=NOPROMPT, then Tip line appears on the receipt.
• If TIP=NONE, then there will not be any prompt for Tip or print Tip Line on the receipt.

• 0 – Do not tokenize.
• 1 – Generate matching token.
• 2 – Generate both payment and matching tokens. NOTE: Value 2 is applicable to UGP only and this is the default value.
• 3 - Generate 3rd party token from the Processor (Chase, Worldpay) outside of VHT.
• 4 - Return Low Value Token (LVT). NOTE: Value 4 is applicable for Worldpay Direct (TOKENIZE = 4 is required to support LVT in Standalone mode only).

• 0 – Disable
• 1 – Enable

• 0 – Disable
• 1 – Enable

• Payment|VAS
• Payment&VAS
• Payment
• VAS

• 0 - Disabled
• 1 - Enabled

Numeric, 1

• -1 - Retains the current system settings.
• 0 - Sets the Wi-Fi band to AUTO.
• 1 - Sets the Wi-Fi band to 2.4 GHz.
• 2 - Sets the Wi-Fi band to 5 GHz.