Configuration parameters
Update parameters through one of the following methods:
- TMS: update available remotely by our TMS.
- API: update available through the In-Store Payments API by a semi-integrated POS.
System parameters
Your HWVENDORID parameter is assigned at the beginning of the integration project by the Chase Integration Agent. If you have not already been assigned a HWVENDORID, consult your Integration Agent for this value. When you launch your POS application, pass the HWVENDORID parameter into Payment Terminal Application.
Refer to the following SetParameter
request example for how to include the HWVENDORID:
{
"operation": "SetParameter",
"parameters": [
{
"key": "HWVENDORID",
"value": "ABCD1234"
}
]
}
Parameter |
Description |
TMS |
API |
Format |
Value |
---|---|---|---|---|---|
HWVENDORID |
The POS Vendor ID that is assigned for each Integration. Parameter must be populated by the POS with each transaction. |
Y |
N |
Text |
|
TAXPERCENT |
Calculated tax percentage. Used to prepopulate the tax amount. If empty or value set to zero this is not enabled. |
Y |
Y |
Float |
Default=0.00 |
STATICTIP |
Static TIP Set A predetermined tip on every transaction. If empty or value set to zero this is not enabled. |
Y |
Y |
Float |
Default=0.00 |
TIPEXCEED |
Percentage of the tip amount exceeds and needs approval. If empty or value set to zero this is not enabled. |
Y |
Y |
Float |
Default=0.00 |
LANG |
UI language. The language employed in the user interface |
Y |
Y |
Num |
0=English 1=French 2=Spanish Default=0 |
ENGVAR |
The supported English variety. |
Y |
Y |
Num |
0=American 1=British Default=0 |
NUMLOGDAYS |
The number of days to keep the logging information |
Y |
N |
Num |
Default=1 |
NUMBATCHSAVEDAYS |
Number of days during which batch settlement info is saved. Information used for reporting purposes. |
Y |
N |
Num |
Default=5 |
NUMDAYSAUTH |
Number of days to keep open authorizations and tabs. After the defined number of days, the application auto reverses the authorizations. A value of 0 disables this feature. |
Y |
N |
Num |
Default=0 |
DEMOMODE |
Controls Demo mode. While in demo mode, no transactions are sent online and the settlement operation is replaced by a reminder that the application is running in demo mode. The maximum amount allowed for transactions in demo mode is $5.00 |
Y |
Y |
Num |
0=Off 1=On Default=0 |
AUTOCLOSE |
Controls if the Close Batch is triggered automatically at a specific hour (daily). Format HHMM 9999=Disabled 0000-2359=Time to trigger Close Batch |
Y |
Y |
Text |
Default=9999 |
TIME1 |
Defines the timeout for generic customer input / selection screens. Expressed in seconds. Value 0 means no timeout. |
Y |
Y |
Num |
Default=30 |
TIME2 |
Defines the timeout for the PIN Entry screen. Expressed in seconds. Value 0 means no timeout. |
Y |
Y |
Num |
Default=30 |
TIME3 |
Defines the timeout for the signature capture screen. Expressed in seconds. Value 0 means no timeout. |
Y |
Y |
Num |
Default=45 |
TIME4 |
Defines the timeout to display the screensaver screen. Expressed in seconds. Value 0 means no timeout. |
Y |
Y |
Num |
Default=45 |
TIME5 |
Defines the timeout to enter power save / sleep mode. Expressed in seconds. Value 0 means no timeout. |
Y |
Y |
Num |
Default=240 |
TIME6 |
Defines 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 |
Num |
Default=600 |
APPLOGO |
Defines the file name for the screen logo icon. If no name is provided no icon is presented. |
Y |
Y |
Text |
|
COUNTRY |
Defines the country code in numeric format (according to ISO 3166). |
Y |
N |
Num |
Default=840 |
CURRENCY |
Defines the currency code in numeric format (according to ISO 4217). |
Y |
N |
Num |
Default=840 |
EMVMODE |
Defines if the application is implementing EMV standard or EMV Quick Chip. |
Y |
N |
Num |
0=Quick Chip 1=EMV Standard Default=0 |
REBTIME |
Defines 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 |
Num |
Default=0200 |
IDLELOGO |
Defines the path to the idle screen logo file. |
Y |
N |
Text |
|
IDLEMSG |
Defines the text message to present on the idle screen |
Y |
N |
Text |
|
IDLETIME |
Defines the time to toggle between displaying the image and the text message in the idle screen. Expressed in seconds. |
Y |
N |
Num |
Default=5 |
TOKENSUP |
Defines if tokenization is supported. |
Y |
N |
Num |
0=Supported 1=Not supported Default=0 |
E2ESUP |
Defines if end-to-end encryption is supported. |
Y |
N |
Num |
0=Supported 1=Not supported Default=0 |
PINBYPASS |
Defines if PIN entry can be bypassed by the cardholder. |
Y |
N |
Num |
0=Supported 1=Not Supported Default=0 |
FALLBACKALLOWED |
Defines if fallback transactions are allowed. Fallback is only possible if enabled by this parameter, and if magnetic stripe transactions are also enabled with |
Y |
N |
Num |
0=Supported 1=Not Supported Default=0 |
MSRALLOW |
Defines if magstripe transactions are allowed. |
Y |
N |
Num |
0=Supported 1=Not Supported Default=0 |
MACINGOPT |
(Canada Only) Defines if MACing is enabled for Canadian Debit transactions. |
Y |
N |
Num |
0=MAC is disabled 1=MAC is enabled Default=0 |
Transaction parameters
Parameter |
Description |
TMS | API | Format |
Value |
---|---|---|---|---|---|
CVVREQ |
CVV Required. Controls CVV Prompting |
Y |
N |
Num |
0=Optional 1=Required Default=1 |
MANENTRY |
Manual Entry Allowed Defines if manual entry is allowed as a fallback method. This is not applicable to MOTO transactions. |
Y |
N |
Num |
0=Allowed 1=Not allowed Default=0 |
AVSCHECK |
Address Verification. Controls AVS Merchant Prompting |
Y |
N |
Num |
0=Off 1=Zip Only 2=Street 3=Both Default=0 |
INVOICENBR |
Invoice Number Prompting. Controls prompting for invoice number |
Y |
Y |
Num |
0=Do not prompt 1=Prompt Default=0 |
CUSTOMERNBR |
Customer Number Prompting. Controls prompting for customer number |
Y |
Y |
Num |
0=Do not prompt 1=Prompt Default=0 |
TICKETNBR |
Ticket Number Prompting. Controls prompting for ticket number |
Y |
Y |
Num |
0=Do not prompt 1=Prompt Default=0 |
PURCHASENBR |
Purchase Number Prompting. Controls prompting for purchase number |
Y |
Y |
Num |
0=Do not prompt 1=Prompt Default=0 |
TAX |
TAX Prompting. Controls prompting for TAX Amount |
Y |
Y |
Num |
0=Do not prompt 1=Prompt (optional entry) 2=Prompt (required) Default=0 |
TAXLABEL |
Defines the tax label to be used in screens and receipts. |
Y |
N |
Text |
Default=“Tax” |
TAXNBR |
When defined, contains the merchant registered tax number. |
Y |
N |
Num |
|
COMMERCIAL |
Commercial / Purchase card prompting. Controls if commercial / purchase card acceptance is enabled. |
Y |
N |
Num |
0=Not supported 1=Supported Default=0 |
TIP |
TIP Amount Prompting. |
Y |
Y |
Num |
0=Do not process tip 1=Process tip and prompt 2=Process tip do not prompt Default=0 |
ACCTNAME |
Controls prompting for confirmation of name and account number |
Y |
Y |
Num |
0=Do not display 1=Name Only 2=Account Only 3=Both Default=0 |
LAST4DIGITS |
Fraud control. Controls prompting to confirm the last 4 digits of the card |
Y |
Y |
Num |
0=Do not prompt 1=Prompt Default=0 |
DUPCHECK |
Duplicate transaction check Controls prompting to confirm if transaction is a duplicate. |
Y |
Y |
Num |
0=Do not prompt 1=Prompt Default=0 |
RECEIPTOPT |
Receipt Printing Options Options for different types of printing options |
Y |
Y |
Num |
0=Print Customer and Merchant 1=Print Customer Receipt Only 2=Print Merchant Only 3=No receipts (only print the mandatory offline declined receipts) Default=0 |
EPORTOPT |
Report Printing / Viewing Options Defines how the reports are presented. |
Y |
Y |
Num |
0=Displayed 1=Printed only Default=0 |
MINAMOUNT |
Minimum amount of the transaction prevents 0.00 amount or low value transactions |
Y |
Y |
Float |
Amount 0.00 disables functionality Default=0.00 |
MAXAMOUNT |
Maximum amount of a transaction |
Y |
Y |
Float |
Amount 0.00 disables functionality Default=0.00 |
MAXREFUNDAMT |
Maximum amount of the refund transaction |
Y |
N |
Float |
Amount 0.00 disables functionality Default=0.00 |
CONFIRMAMT |
Prompt to confirm the amount |
Y |
Y |
Num |
0=Do not prompt 1=Prompt Default=0 |
SIGCAPTURE |
Signature Capture. Prompt for the customer to Sign |
Y |
Y |
Num |
0=Do not prompt 1=Prompt Default=0 |
SIGCONTROL |
Signature Control Controls whether the terminal prompts for and captures signature. When set up for tip on receipt, the terminal ignores signature suppression as signature is required in this mode. |
Y |
Y |
Num |
0=Do not suppress signature 1=Suppress signature (no prompting for onscreen capturing and no signature line on the receipt) 2=Always require signature regardless of the CVM Default=0 |
CHNPRINT |
Cardholder Name Options Controls if the cardholder name is present in receipts. |
Y |
N |
Num |
0=Present 1=Not present Default=0 |
EBTSUP |
EBT Support Options for supporting EBT |
Y |
N |
Num |
0=Not supported 1=SNAP only 2=SNAP and Cash 3=Cash only Default=0 |
CASHBACK |
Options for cashback amount prompting. |
Y |
N |
Num |
0=Do not prompt 1=Prompt for cashback amount Default=0 |
CASHBACKEBT |
Options for cashback amount prompting on EBT transactions. |
Y |
N |
Num |
0=Do not prompt 1=Prompt for cashback amount Default=0 |
CASHDISCOPT |
Cash Discount options Allows prompting for cash discount applicability to allow the merchant to waive certain transactions at will. |
Y |
N |
Num |
0=Do not prompt 1=Prompt Default=0 |
CASHDISCPERC |
Cash discount percentage Determines the percentage to add as non-cash adjustment. |
Y |
N |
Float |
0.00 disables Default=0.000 |
PARTIALVOID |
Partial Void Control. Defines if partial Voids are allowed. |
Y |
N |
Num |
0=Not allowed 1=Allowed Default=0 |
TIPPERC1 |
Suggested tip percentage 1. Defines the percent value to be suggested as tip |
Y |
Y |
Float |
0.00 disables this feature Default=0.00 |
TIPPERC2 |
Suggested tip percentage 2. Defines the percent value to be suggested as tip |
Y |
Y |
Float |
0.00 disables this feature Default=0.00 |
TIPPERC3 |
Suggested tip percentage 3. Defines the percent value to be suggested as tip |
Y |
Y |
Float |
0.00 disables this feature Default=0.00 |
TIPPERC4 |
Suggested tip percentage 4. Defines the percent value to be suggested as tip |
Y |
Y |
Float |
0.00=feature disabled (default) Default=0.00 |
TIPPERC5 |
Suggested tip percentage 5. Defines the percent value to be suggested as tip |
Y |
Y |
Float |
0.00=feature disabled (default) Default=0.00 |
CASHBACK1 |
Pre-defined cashback amount 1. If not defined, no pre-defined cashback amounts are presented. |
Y |
Y |
Num |
0=feature disabled (default) |
CASHBACK2 |
Pre-defined cashback amount 2. If not defined, only CASHBACK1 is presented (if defined). |
Y |
Y |
Num |
0=feature disabled (default) |
CASHBACK3 |
Pre-defined cashback amount 3. If not defined, only CASHBACK1 and CASHBACK2 are presented (if defined). |
Y |
Y |
Num |
0=feature disabled (default) |
CASHLIM |
The maximum allowed cashback amount. Defines the maximum cashback that can be added to the transaction. |
Y |
N |
Num |
0=feature disabled (default) |
CARDCHECK |
Controls prompting the cardholder for ZIP code and CVV2. |
Y |
Y |
Num |
0=No prompt (default) 1=Prompt for ZIP 2=Prompt for ZIP and CVV2 |
TRANSRES |
Allows enabling / disabling the approval / declined screen. |
Y |
Y |
Num |
0=Disabled 1=Enabled (default) |
PARTIALAPP |
Defines if partial authorizations are supported. When supported, a transaction can be authorized for a lesser amount than what was requested. |
Y |
N |
Num |
0=Disabled 1=Enabled (default) |
DEBITREF |
Defines if debit Refunds are allowed |
Y |
N |
Num |
0=Not allowed 1=Allowed (default) |
Receipt parameters
Parameter |
Description |
TMS | API | Format |
Value |
---|---|---|---|---|---|
PROCHEAD1 |
Processor Line 1. Processor DBA information for all languages. |
Y |
N |
Text |
42 characters |
PROCHEAD2 |
Processor Line 2 Processor DBA information for all languages. |
Y |
N |
Text |
42 characters |
HEADERLN1 |
Merchant Header 1 Receipt/Report header Information for all languages. |
Y |
Y |
Text |
42 characters |
HEADERLN2 |
Merchant Header 2 Receipt/Report header Information for all languages. |
Y |
Y |
Text |
42 characters |
HEADERLN3 |
Merchant Header 3 Receipt/Report header Information for all languages. |
Y |
Y |
Text |
42 characters |
HEADERLN4 |
Merchant Header 4 Receipt/Report header Information for all languages. |
Y |
Y |
Text |
42 characters |
HEADERLN5 |
Merchant Header 5 Receipt/Report header Information for all languages. |
Y |
Y |
Text |
42 characters |
HEADERLN6 |
Merchant Header 6 Receipt/Report header Information for all languages. |
Y |
Y |
Text |
42 characters |
CUSTLOGO |
Logo File Location of the logo (Path to the file) |
Y |
N |
Text |
42 characters |
FOOTLN1 |
Footer Line Receipt Information 1 in English |
Y |
Y |
Text |
42 characters |
FOOTLN2 |
Footer Line Receipt Information 2 in English |
Y |
Y |
Text |
42 characters |
FOOTLN3 |
Footer Line Receipt Information 3 in English |
Y |
Y |
Text |
42 characters |
FOOTLN1SP |
Footer Line Receipt Information 1 in Spanish |
Y |
Y |
Text |
42 characters |
FOOTLN2SP |
Footer Line Receipt Information 2 in Spanish |
Y |
Y |
Text |
42 characters |
FOOTLN3SP |
Footer Line Receipt Information 3 in Spanish |
Y |
Y |
Text |
42 characters |
FOOTLN1FR |
Footer Line Receipt Information 1 in French |
Y |
Y |
Text |
42 characters |
FOOTLN2FR |
Footer Line Receipt Information 2 in French |
Y |
Y |
Text |
42 characters |
FOOTLN3FR |
Footer Line Receipt Information 3 in French |
Y |
Y |
Text |
42 characters |
PRTCOLS |
The number of columns the printer uses (for fixed size fonts) |
Y |
Y |
Num |
0=20 columns (default) 1=40 columns |
RCPFNT |
Receipts Font Height Defines the font height used in printing receipts. |
Y |
Y |
Num |
0=Condensed (default) 1=Normal |
RPTFNT |
Reports Font Height Defines the font height used in printing reports. |
Y |
Y |
Num |
0=Condensed (default) 1=Normal |
VISARCP |
Control the presence of TID and MID on the receipt for Visa transactions. |
Y |
N |
Num |
0=Only TID (default) 1=Only MID 2=Both present 3=None |
MCRCP |
Control the presence of TID and MID on the receipt for MasterCard transactions. |
Y |
N |
Num |
0=Only TID (default) 1=Only MID 2=Both present 3=None |
DISCRCP |
Control the presence of TID and MID on the receipt for Discover transactions. |
Y |
N |
Num |
0=Only TID (default) 1=Only MID 2=Both present 3=None |
AMEXRCP |
Control the presence of TID and MID on the receipt for Amex transactions. |
Y |
N |
Num |
0=Only TID (default) 1=Only MID 2=Both present 3=None |
UPRCP |
Control the presence of TID and MID on the receipt for UnionPay transactions. |
Y |
N |
Num |
0=Only TID (default) 1=Only MID 2=Both present 3=None |
JCBRCP |
Control the presence of TID and MID on the receipt for JCB transactions. |
Y |
N |
Num |
0=Only TID (default) 1=Only MID 2=Both present 3=None |
INTERACRCP |
Control the presence of TID and MID on the receipt for Interac transactions. |
Y |
N |
Num |
0=Only TID (default) 1=Only MID 2=Both present 3=None |
Merchant parameters
Parameter |
Description |
TMS | API | Format |
Value |
---|---|---|---|---|---|
ACQUIRINGID |
Acquiring institution ID. Identifies the acquirer. |
Y |
N |
Num |
|
TERMID |
Terminal ID. Identifies the terminal in the acquirer system. |
Y |
N |
Num |
|
STOREID |
Store ID. Identifies the store within the Merchant. |
Y |
N |
Num |
|
MERCID |
Merchant ID. Identifies the merchant in the acquirer system. This is only used internally within the Payment Terminal Application and not exposed on any interfaces. |
Y |
N |
Num |
12 digits |
BMERCID |
Public merchant ID. Used to identify the merchant in all public user interfaces including receipts and application UI. |
Y |
N |
NUM |
7 digits |
MERCNM |
Merchant name. Contains a description of the merchant |
Y |
Y |
Text |
42 characters |
MERCBN |
Merchant batch number. Contains the initial value for the batch counter |
Y |
Y |
Num |
|
MCC |
Merchant Category Code Contains the standard industry classification for the merchant. |
Y |
Y |
Num |
4 characters |
DBANAME |
“Doing business as” name of the merchant. This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
25 characters |
SMERCID |
Sub merchant Identifier. This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
8 characters |
SMERCSTREET |
Sub merchant street. This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
25 characters |
SMERCCITY |
Sub merchant city. This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
25 characters |
SMERCSTATE |
Sub merchant state. This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
3 characters |
SMERCPOST |
Sub merchant postal code. This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
9 characters |
SMERCCTRY |
Sub merchant country code. This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Num |
3 characters |
SENTITLMNT |
Sub entitlement number. This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
20 characters |
CONTACT |
Merchant contact / phone. This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
20 characters |
Merchant email address. This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
40 characters |
|
SELLERID |
Seller account Identifier This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
20 characters |
501C3 |
Sub merchant 501c3 eligibility This is required if Payment Terminal Application is operating in aggregator or payment facilitator mode. |
Y |
Y |
Text |
1 character N=No Y=Yes |
Communication parameters
Parameter |
Description |
TMS | API | Format |
Value |
---|---|---|---|---|---|
HOSTIP |
The payment host IP address or URL. For an IP address, separate the subfields with a period |
Y |
Y |
Text |
|
HOSTPORT |
The payment host IP port. |
Y |
Y |
Num |
|
ENTRYPOINT |
The suffix used to append to the HOSTIP URL parameter. Include any ‘/’ characters that are part of the entry point. |
Y |
N |
Test |
|
HOSTIP2 |
Secondary payment host IP address or URL. For an IP address, separate the subfields with a period |
Y |
Y |
Text |
|
HOSTPORT2 |
Secondary payment host IP port. |
Y |
Y |
Num |
|
SIMID |
The GPRS SIM card serial number. The value of this parameter is auto populated based on the SIM card inserted. If no SIM card is in use, this parameter is empty. |
Y |
N |
Text |
|
DHCP |
Defines if DHCP is used by the terminal. This setting overrides the OS corresponding setting. |
Y |
Y |
Num |
0=Not used (default) 1=Used |
STATICIP |
Defines a static IP address for the terminal. This setting overrides the OS corresponding setting. |
Y |
Y |
Text |
|
NETMASK |
Defines the subnet mask for the terminal. This setting overrides the OS corresponding setting. |
Y |
Y |
Text |
|
GATEWAY |
Defines IP gateway for the terminal. This setting overrides the OS corresponding setting. |
Y |
Y |
Text |
|
DNS1 |
Defines the primary DNS address for the terminal. This setting overrides the OS corresponding setting. |
Y |
Y |
Text |
|
DNS2 |
Defines the secondary DNS address for the terminal. This setting overrides the OS corresponding setting. |
Y |
Y |
Text |
|
DEVICEGUID |
This is an unique device identifier used by Tandem. |
Y |
Y |
Text |
|
APN |
Contains one or more APN numbers to be used for mobile network communications. Multiple numbers are separated by semicolon ‘;’ |
Y |
N |
Test |
Store and Forward parameters
Parameter |
Description |
TMS | API | Format |
Value |
---|---|---|---|---|---|
SAF | Turn on or off the Store and Forward (SAF) function. | Y | N | Num | 0=Off (default) 1=On |
SAFNUMBER | Set the maximum allowed number of SAF transactions (Sales and Refunds). |
Y | N | Num | 0=Off, no maximum (default) |
SAFSALETOTAL | Set the maximum cumulative amount for all stored Sale transactions. |
Y | N | Float | 0.00=Off, no maximum (default) |
SAFREFTOTAL | Set the maximum cumulative amount for all stored Refund transactions. |
Y | N | Float | 0.00=Off, no maximum (default) |
SAFSALEFLOOR | Set the maximum SAF Sale transaction amount. | Y | N | Float | 0.00=Off, no maximum (default) |
SAFREFMAX |
Set the maximum SAF Refund transaction amount. | Y | N |
Float |
0.00=Off, no maximum (default) |
SAFENTRY |
Turn on or off manual entry during SAF. | Y |
Y |
Num |
0=All entry modes accepted 1=All except manual entry |
SAFINTER |
Turn on to allow international card acceptance during SAF. Note that this does not apply to MSR cards. | Y | Y | Num | 0=Off (default) 1=On |