Skip to main content
In-Store Payments

Configuration parameters

You can modify the Payment Terminal Application with a variety of settings called parameters. The following are the most commonly used parameters for semi-integrated environments, including the all-in-one use case where the point-of-sale (POS) application is on the payment terminal, referred to as On Device. 

How to set parameters

All parameters are configured in our Terminal Management System (TMS) and are noted in the TMS column. Some parameters are also configured through the API using the SetParameter operation or in a card transaction operation. 

Attention

When you set a parameter using a card transaction operation, the parameter is set for that operation only. 

The following examples show how you can set the parameter TIME1 through the SetParameter operation and in a Sale request. These examples set the terminal timeout period for consumer input.

The following example sets the TIME1 parameter using the SetParameter operation:

Json
{ 
    "operation": "SetParameter", 
    "parameters": [ 
        { 
            "key": "TIME1", 
            "value": "45" 
        } 
    ] 
}

The following example sets the TIME1 parameter in an individual sale request:

Json
{ 
  "operation": "Transaction", 
  "type": "SALE", 
  "requestedAmount": "500", 
  "parameters": [ 
    { 
      "key": "TIME1", 
      "value": "45" 
    } 
  ] 
}

System parameters

The following table lists and defines the system parameters.

System parameters
Parameter Description TMS API Format Constraints Parameter values
AUTOCLOSE
  • Controls if Close Batch is triggered automatically at a specific hour (daily). 
  • Format HHMM 
  • 9999=Disabled 
  • 0000-2359=Time to trigger Close Batch
 Y Y Numeric string HHMM 9999 (default)
COUNTRY Sets the country code in numeric format (according to ISO 3166). Y N N/A 3 integers
  • 840 (USA, default) 
  • 124 (Canada)
CURRENCY Sets the currency code in numeric format (according to ISO 4217). Y N N/A 3 integers
  • 840 (USA, default) 
  • 124 (Canada)
ENGVAR The supported variety of English: American or British. Y Y Numeric string 0, 1
  • 0=American (default) 
  • 1=British
HWVENDORID
  • An identifier assigned to your integration.
  • Send the HWVENDORID with each transaction or configure it once when you set up a new terminal.
 Y Y Alphanumeric string 4 characters Assigned during integration
LANG The language employed in the user interface. Y Y Numeric string 0, 1, 2
  • 0=English (default) 
  • 1=French 
  • 2=Spanish
MSRALLOW Controls if magstripe transactions are allowed. Y N N/A 0, 1
  • 0=Supported (default) 
  • 1=Not Supported
NUMLOGDAYS The number of days to keep the logging information. Y N N/A Integer 8 (default)
PINBYPASS Enables or disables the cardholder option to bypass PIN entry. Y N N/A 0, 1
  • 0=Supported (default) 
  • 1=Not Supported
REBTIME
  • Sets the daily auto reboot time. 
  • The application attempts to reboot after this time whenever it is in idle state. 
  • The format for this parameter is HHMM.
 Y N N/A HHMM 0200 (default)
TAXPERCENT
  • Calculated tax percentage and used to prepopulate the tax amount. 
  • Not enabled if empty or the value is set to 0.
 Y Y Numeric string 3 implied decimals 
(10000 = 10.000%)		 0 (default)
TIME1
  • Sets the timeout for generic customer input and selection screens. 
  • Expressed in seconds. 
  • Value 0 means no timeout.
 Y Y Numeric string 86400 30 (default)
TIME2
  • Sets the timeout for the PIN Entry screen. 
  • Expressed in seconds. 
  • Value 0 means no timeout.
 Y Y Numeric string 86400 30 (default)
TIME3
  • Sets the timeout for the signature capture screen. 
  • Expressed in seconds. 
  • Value 0 means no timeout.
 Y Y Numeric string 86400 45 (default)
TIME4
  • Sets the timeout to display the screensaver screen. 
  • Expressed in seconds. 
  • Value 0 means no timeout.
 Y Y Numeric string 86400 45 (default)
TIME5
  • Sets the timeout to enter power save / sleep mode. 
  • Expressed in seconds. 
  • Value 0 means no timeout.
 Y Y Numeric string 86400 240 (default)
TIME6
  • Sets the timeout to shut down the terminal when running on battery. This timer starts after entering sleep mode (controlled by TIME5). 
  • Expressed in seconds. 
  • Value 0 means no timeout.
 Y Y Numeric string 86400 600 (default)
TIME7
  • Sets the presentation time for the transaction outcome screen. 
  • The value is expressed in seconds. After the time elapses, the application returns to the idle screen. 
  • When set to 0, the value of TIME1 defines the presentation time. If both TIME7 and TIME1 are set to 0, the transaction outcome screen remains until cleared.
 Y Y Numeric string 86400 Default=0
UITIMEOUT Controls how the user interface manages timeout events in Semi-Integrated mode. Y Y Numeric string 0, 1, 2
  • 0=Display timeout prompt only; don't show option to extend timeout 
  • 1=Display both timeout and extend timeout prompts (default) 
  • 2=Don't display any prompts for timeout or extension

Transaction parameters

The following table lists and defines the transaction parameters.

Transaction parameters
Parameter Description TMS API Format Constraints Parameter values
AVSCHECK Controls prompting for address verification service (AVS). Y N N/A 0, 1, 2, 3
  • 0=Disabled (default) 
  • 1=ZIP Only 
  • 2=Street  
  • 3=Both
CARDCHECK Controls prompting the cardholder for ZIP code and CVV2.  Y Y Numeric string 0, 1, 2
  • 0=No prompt (default) 
  • 1=Prompt for ZIP 
  • 2=Prompt for ZIP and CVV2
CASHBACK Controls cash back amount prompting.  Y N N/A 0, 1, 2
  • 0=Do not prompt (default) 
  • 1=Prompt before card entry 
  • 2=Prompt after card entry
CASHBACK1
  • If cashback is prompted (parameter CASHBACK=1 or 2), this sets pre-defined cashback amount 1. 
  • If not defined, no pre-defined cashback amounts are presented.
 Y Y Numeric string Minor units 
(500 = USD 5.00)		 0=feature disabled (default)
CASHBACK2
  • If cashback is prompted (parameter CASHBACK=1 or 2), this sets pre-defined cashback amount 2. 
  • If not defined, only CASHBACK1 is presented (if defined).
 Y Y Numeric string Minor units 
(500 = USD 5.00)		 0=feature disabled (default)
CASHBACK3
  • If cashback is prompted (parameter CASHBACK=1 or 2), this sets pre-defined cashback amount 3. 
  • If not defined, only CASHBACK1 and CASHBACK2 are presented (if defined).
 Y Y Numeric string Minor units 
(500 = USD 5.00)		 0=feature disabled (default)
CASHBACKEBT Options for cash back amount prompting on EBT transactions when parameter EBTCB=1 or 2. Y N N/A 0, 1
  • 0=Do not prompt (default) 
  • 1=Prompt for cash back
CASHLIM Sets the maximum cashback amount that can be added to a transaction. Y N N/A 0, 1 0=feature disabled (default)
CHNPRINT Controls if the cardholder name is present in receipts. Y N N/A 0, 1
  • 0=Present (default) 
  • 1=Not present
CLRKSERV Controls prompting for the CLERK Number (Retail setting) or the SERVER Number (restaurant setting) depending on your Payment Terminal Application configuration. Y Y Numeric string 0, 1
  • 0=Don't prompt (default) 
  • 1=Prompt
COMMERCIAL Controls if commercial/purchase card acceptance is enabled. Y N N/A 0, 1
  • 0=Not supported (default) 
  • 1=Supported
CONFIRMAMT Controls whether the Payment Terminal Application prompts the user to confirm the total amount before processing transaction. Y Y Numeric string 0, 1
  • 0=Don't prompt (default) 
  • 1=Prompt
CVMLIM
  • Determines amount transaction can be accepted with no card verification method (CVM). 
  • Used only for magstripe and EMV Contact transactions for all card brands.
 Y N N/A Minor units 
(500 = USD 5.00)		 0=disabled (default)
CVVREQ Controls prompting for the card verification value (CVV) for manual card entry. Y N N/A 0, 1
  • 0=Optional 
  • 1=Required (default)
DEBITREF Controls if debit refunds are allowed. Y N N/A 0, 1
  • 0=Not allowed 
  • 1=Allowed (default)
DUPCHECK Controls whether the Payment Terminal Application checks if the current transaction has the same account number and transaction amount as the previous transaction. If there is a match, the terminal displays Duplicate Transaction. Are you sure? with Cancel or Confirm actions. Y Y Numeric string 0, 1
  • 0=Do not prompt 
  • 1=Prompt (default)
EBTSUP
  • Controls how electronic benefits transfer (EBT) transactions are supported.
  • US only.
 Y N N/A 0, 1, 2, 3
  • 0=Not supported (default) 
  • 1=SNAP only 
  • 2=SNAP and Cash 
  • 3=Cash only
ENFORCEAVS Controls if transactions should automatically be reversed and decline based address verification service (AVS) mismatch. Y N N/A 0, 1, 2
  • 0=Don't decline (default) 
  • 1=Decline if either address or ZIP don't match 
  • 2=Decline if address and ZIP don't match
GCMASK Controls if the gift card number should be masked on receipts. Y Y Alphanumeric string 0, 1
  • 0=Masked (default) 
  • 1=Not masked
LAST4DIGITS Controls prompting to confirm the last 4 digits of the card. Y Y Numeric string 0, 1
  • 0=Don't prompt (default) 
  • 1=Prompt
MANENTRY
  • Controls if manual entry is allowed as a fallback method. 
  • This is not applicable to MOTO transactions.
 Y N N/A 0, 1
  • 0=Allowed (default) 
  • 1=Not allowed
MAXAMOUNT Sets a maximum authorization amount for a single transaction. Y Y Numeric string Minor units 
(500 = USD 5.00)		 0=disabled (default)
MAXREFUNDAMT Sets a maximum refund amount for a single transaction. Y N N/A Minor units 
(500 = USD 5.00)		 0=disabled (default)
MAXTABLE
  • Sets the maximum number of tables being served. 
  • Only applicable in Restaurant mode.
 Y Y Numeric string 3 integers 999 (default)
MINAMOUNT Sets a minimum authorization amount for a single transaction. Y Y Numeric string Integer 0=disabled (default)
NOTIP
  • Controls the display of the No Tip option on the Payment Terminal Application. 
  • Only applies when parameter TIP=1.
 Y Y Numeric string 0, 1, 2
  • 0=Screen doesn't include No Tip button  
  • 1=Screen includes button with No Tip (default) 
  • 2=Screen includes button with Cash Tip
PARTIALAPP Controls if partial authorizations are supported. When supported, a transaction can be authorized for a lesser amount than what was requested. Y N N/A 0, 1
  • 0=Disabled 
  • 1=Enabled (default)
PROVAMT
  • Controls the provisional amount to be used when the application is running in Quick Chip mode and the final amount is known only after the card is read. 
  • A value of 0 disables the ability of reading a card before knowing the final amount.
 Y N N/A Integer
  • 0=Disabled 
  • 2000 (20.00, default)
RECEIPTOPT Controls which receipt(s) to print. Y Y Numeric string 0, 1, 2, 3
  • 0=Print consumer and merchant receipts (default) 
  • 1=Print consumer receipt only 
  • 2=Print merchant receipt only 
  • 3=No receipt printing except mandatory offline declined receipts
SIGCAPTURE
  • Controls prompting for cardholder signature on the payment terminal touch screen. 
  • This option does not capture the signature for later retrieval.
 Y Y Numeric string 0, 1
  • 0=Don't prompt (default) 
  • 1=Prompt Default=0
SIGCONTROL
  • Controls whether the signature line prints on the receipt or if the Payment Terminal Application should not print signature line when the cardholder verification method (CVM) is set.
  • This is defined by the chip on the card.
 Y Y Numeric string 0, 1, 2
  • 0=Don't suppress signature (default) 
  • 1=Suppress signature 
  • 2=Always require signature
STATICTIP Sets a static tip percentage for the requestedAmount on every transaction when tipping on the terminal is enabled (parameter TIP = 1). Y Y Numeric string 3 implied decimals 
(10000 = 10.000%)		 0 (default)
TAXLABEL Sets the tax label to be used on receipts. Y N N/A   "Tax:" (default)
TAXLABEL2 Sets the second tax label to be used on receipts. Y N N/A   "TAX2:" (default)
TAXNBR
  • Sets the merchant registered tax number.
  • Canada (CA) use only. 
 Y N N/A   0=disabled (default)
TICKETNBR Controls prompting for the ticket number Y Y Numeric string 0, 1
  • 0=Do not prompt 
  • 1=Prompt Default=0
TIP Controls tip prompting.  Y Y Numeric string 0, 1
  • 0=No Tip (default) 
  • 1=Prompt for tip on the terminal
TIPAMT1 Defines suggested fixed tip amount for option 1 when tipping on the terminal is enabled (parameter TIP=1). Y Y Numeric string Minor units 
(500 = USD 5.00)		 100 (1.00, default)
TIPAMT2 Defines suggested fixed tip amount for option 2 when tipping on the terminal is enabled (parameter TIP=1). Y Y Numeric string Minor units 
(500 = USD 5.00)		 300 (3.00, default)
TIPAMT3 Defines suggested fixed tip amount for option 3 when tipping on the terminal is enabled (parameter TIP=1). Y Y Numeric string Minor units 
(500 = USD 5.00)		 500 (5.00, default)
TIPCALC Controls how the tip suggestions are calculated. Y N N/A 0, 1
  • 0=Based on the transaction amount (default) 
  • 1=Based on transaction amount + tax(es)
TIPGUIDE
  • Controls how the guide text below the primary tip suggestions are presented on the tipping buttons. 
  • Only applies when parameter TIP=1.
 Y Y Numeric string 0, 1
  • 0=The guide text below the button shows the final amount including tax and tip. This applies to both percentage and amount suggestions (controlled by the parameter TIPOPT). (default).
  • 1=The guide text below the button shows the tip amount calculated per the percentage on the button. This only applies to the percentage suggestions. If TIPOPT = 1 (prompt for suggested amounts), the guide is not shown.
TIPOPT Controls additional options for tip prompting when tipping on the terminal is enabled (parameter TIP=1). Y Y Numeric string 0, 1, 2
  • 0=suggested percentages (default)  
  • 1=suggested amounts  
  • 2=suggested amounts up to a threshold, and then suggested percentages, for example, tipping dollar amounts up to $10 and percentages above
TIPPERC1 Defines suggested tip percentage for option 1 when tipping on the terminal is enabled (parameter TIP=1). Y Y Numeric string 3 implied decimals 
(10000 = 10.000%)		 15000 (15.000%, default)
TIPPERC2 Defines suggested tip percentage for option 2 when tipping on the terminal is enabled (parameter TIP=1). Y Y Numeric string 3 implied decimals 
(10000 = 10.000%)		 18000 (18.000%, default)
TIPPERC3 Defines suggested tip percentage for option 3 when tipping on the terminal is enabled (parameter TIP=1). Y Y Numeric string 3 implied decimals 
(10000 = 10.000%)		 20000 (20.000%, default)
TIPTHR Controls the tip threshold amount when parameter TIPOPT=2. Y Y Numeric string Minor units 
(500 = USD 5.00)
  • 0=Disabled 
  • 2000 (20.00, default)
TRANSRES Controls whether approval and decline messages appear on the Payment Terminal Application. Y Y Numeric string 0, 1
  • 0=Disabled 
  • 1=Enabled (default)

Receipt parameters

The following table lists and defines the receipt parameters.

Receipt parameters
Parameter Description TMS API Format Constraints Parameter values
FOOTLN1 Card receipt footer line 1 prints the information in English on all receipts (when parameter LANG=0). Y Y Alphanumeric string 26 characters Thank You
FOOTLN1FR Card receipt footer line 1 prints the information in French on all receipts (when parameter LANG=1). Y Y Alphanumeric string 26 characters Please Come Again
FOOTLN1SP Card receipt footer line 1 prints the information in Spanish on all receipts (when parameter LANG=2). Y Y Alphanumeric string 26 characters  
FOOTLN2 Card receipt footer line 2 prints the information in English on all receipts (when parameter LANG=0). Y Y Alphanumeric string 26 characters THANK YOU!/MERCI!
FOOTLN2FR Card receipt footer line 2 prints the information in French on all receipts (when parameter LANG=1). Y Y Alphanumeric string 26 characters Please Come Again
FOOTLN2SP Card receipt footer line 2 prints the information in Spanish on all receipts (when parameter LANG=2). Y Y Alphanumeric string 26 characters  
FOOTLN3 Card receipt footer line 3 prints the information in English on all receipts (when parameter LANG=0). Y Y Alphanumeric string 26 characters  
FOOTLN3FR Card receipt footer line 3 prints the information in French on all receipts (when parameter LANG=1). Y Y Alphanumeric string 26 characters  
FOOTLN3SP Card receipt footer line 3 prints the information in Spanish on all receipts (when parameter LANG=2). Y Y Alphanumeric string 26 characters  
GCFOOTLN1 Gift card receipt footer line 1 prints the information in English on all receipts (when parameter LANG=0). Y Y Alphanumeric string 26 characters  
GCFOOTLN1FR Gift card receipt footer line 1 prints the information in French on all receipts (when parameter LANG=1). Y Y Alphanumeric string 26 characters  
GCFOOTLN1SP Gift card receipt footer line 1 prints the information in Spanish on all receipts (when parameter LANG=2). Y Y Alphanumeric string 26 characters  
GCFOOTLN2 Gift card receipt footer line 2 prints the information in English on all receipts (when parameter LANG=0). Y Y Alphanumeric string 26 characters  
GCFOOTLN2FR Gift card receipt footer line 2 prints the information in French on all receipts (when parameter LANG=1). Y Y Alphanumeric string 26 characters  
GCFOOTLN2SP Gift card receipt footer line 2 prints the information in Spanish on all receipts (when parameter LANG=2). Y Y Alphanumeric string 26 characters  
GCFOOTLN3 Gift card receipt footer line 3 prints the information in English on all receipts (when parameter LANG=0). Y Y Alphanumeric string 26 characters  
GCFOOTLN3FR Gift card receipt footer line 3 prints the information in French on all receipts (when parameter LANG=1). Y Y Alphanumeric string 26 characters  
GCFOOTLN3SP Gift card receipt footer line 3 prints the information in Spanish on all receipts (when parameter LANG=2).  Y Y Alphanumeric string 26 characters  
HEADERLN1 Card receipt header line 1 prints the information on all receipts. Y N Alphanumeric string 26 characters  
HEADERLN2 Card receipt header line 2 prints the information on all receipts. Y Y Alphanumeric string 26 characters  
HEADERLN3 Card receipt header line 3 prints the information on all receipts. Y Y Alphanumeric string 26 characters  
HEADERLN4 Card receipt header line 4 prints the information on all receipts. Y Y Alphanumeric string 26 characters  
HEADERLN5 Card receipt header line 5 prints the information on all receipts. Y Y Alphanumeric string 26 characters  
HEADERLN6 Card receipt header line 6 prints the information on all receipts. Y Y Alphanumeric string 26 characters  
PRTCOLS The number of columns the printer uses for fixed width fonts. Y Y Numeric string 0=20 columns (default) 1=40 columns
  • 0=20 columns (default)  
  • 1=40 columns
RCPFNT Sets the font height used in printing receipts. Y Y Numeric string 0, 1
  • 0=Condensed (default) 
  • 1=Normal

Store and Forward parameters

The following table lists and defines the Store and Forward (SAF) parameters.

SAF parameters
Parameter Description TMS API Format Constraints Parameter values
SAF Turns Store and Forward (SAF) functionality on or off. Y N N/A 0, 1
  • 0=Disabled (default) 
  • 1=On
SAFENTRY Entry mode options when Store and Forward is enabled. Y Y Numeric string 0, 1
  • 0=All entry modes accepted 
  • 1=All except manual entry (default)
SAFINTER
  • Turn on to allow international card acceptance during SAF. 
  • This does not apply to MSR cards.
 Y Y Numeric string 0, 1
  • 0=Disabled (default) 
  • 1=On
SAFNUMBER If Store and Forward is enabled, sets the maximum number of stored transactions allowed until the payment terminal is back online. Y N N/A Integer 0=Disabled - no maximum (default)
SAFREFMAX If Store and Forward is enabled, sets the maximum refund transaction amount. Y N N/A Minor units 
(500 = USD 5.00)
  • 0=Disabled 
  • 10000 (100.00, default)
SAFREFTOTAL If Store and Forward is enabled, sets the maximum cumulative amount for all stored refund transactions. Y N N/A Minor units 
(500 = USD 5.00)
  • 0=Disabled 
  • 30000 (300.00, default)
SAFSALEMAX If Store and Forward is enabled, sets maximum sale amount per transaction. Y N N/A Minor units 
(500 = USD 5.00)
  • 0=Disabled 
  • 25000 (250.00, default)
SAFSALETOTAL If Store and Forward is enabled, sets the maximum cumulative amount for all stored sale transactions. Y N N/A Minor units 
(500 = USD 5.00)
  • 0=Disabled 
  • 100000 (1000.00, default)
SAFUPLOADSIZE Sets the maximum number of Store and Forward records to upload once the Payment Terminal Application has completed a successful online transaction. If set to 0, all pending offline transactions are uploaded. Y Y Numeric string Integer 3 (default)

Reference the card and gift card transaction operations

Refer to the Payment Terminal Application's tipping functionality

Learn more about receipt requirements

Review the Store and Forward function capabilities

Is this page helpful?