Merchant Configuration Field Reference

The Merchant Configuration Field Reference page contains all configuration options that define how a merchant operates within the system. These settings include general business details, contact information, processing rules, virtual terminal options, verification controls, features, and custom fields. This reference explains each section and setting available on the Edit Merchant page, including what the field is used for and how it affects merchant behavior.

General Settings

The General Settings section defines the core identifying information and basic configuration for the merchant. These fields determine how the merchant appears throughout the system, which user account is associated by default, and whether the merchant operates in a test or production mode.

General Settings Fields

FieldDescription
NameThe primary name of the merchant. This is the display name used throughout the system and required for identification.
Custom IdentifierAn optional merchant-defined identifier used for custom tracking or external system mapping.
Parent ResellerThe reseller under which the merchant is grouped. Determines access visibility and organizational structure.
DbaThe merchant's “Doing Business As” name that represents the merchant’s public-facing business name.
Is TestIndicates whether the merchant operates in test mode. When enabled, transactions are restricted to processing with the processors’ test hosts.

Contact Detail

The Contact Detail section stores the merchant’s primary business contact information, including communication details and physical addresses.

Contact Detail Fields

FieldDescription
Primary Contact NameThe name of the merchant’s primary point of contact.
PhoneA primary phone number used for merchant communication.
FaxAn optional fax number associated with the merchant.
Company URLThe merchant's public-facing website or homepage.

Address List Fields

ColumnDescription
Address 1The first line of the merchant’s street address.
CityThe city associated with the address.
StateThe U.S. state or region for the address.
ZipThe ZIP or postal code.
MailingIndicates whether this address is used for mailed communications.
DefaultMarks the address as the primary or default address.

Merchants may have multiple stored addresses, each optionally flagged as a mailing address or default address.

Add / Edit Address Fields

FieldDescription
Address1The first line of the address (street number and street name).
CityThe city associated with the address.
StateState dropdown used to select the merchant’s state or region.
ZipPostal code for the address.
MailingFlags the address as one used for mailed receipts or notifications.
DefaultSets this address as the primary default contact address.

Selecting + Add Address or editing an existing entry opens the address editor.

Business Info

The Business Info section stores key tax, regulatory, and classification details about the merchant’s business.

Business Info Fields

Field NameDescription
Federal Tax IdThe merchant’s tax id.
State Tax IdThe merchant's state-issued tax identification number.
Sales Tax IdThe merchant’s sales ID tax number.
Business Start DateThe date the business originally began operation.
CurrencyThe default operating currency for the merchant.
Ownership TypeSpecifies the business’s ownership type.

Virtual Terminal

The Virtual Terminal section controls which transaction features and fields are available when a merchant processes payments manually through the UI. These settings directly affect what appears on the Virtual Terminal screen for that merchant.

Card Bin Prompting Fields

SettingDescription
Enable CommercialPrompts for commercial card data where applicable.
Enable GSAEnables prompts for U.S. Government Services Administration purchasing cards.
Enable FSAEnables prompts for Flexible Spending Account (FSA) cards that require eligible amount verification.

Transaction Options

SettingDescription
Allow Repeat SalesAllows a merchant to re-run a previous transaction without re-entering all fields.
Allow RefundsEnables refund transactions in the Virtual Terminal.
Enable Email ReceiptsAllows the Virtual Terminal to send receipts to customers via email.

Virtual Terminal Field

This table describes each Virtual Terminal Field that can be enabled, disabled, or configured for the merchants.

Fields may also support additional behavior such as masking, validation, auto-calculation, or default values. If a field is marked Required, the merchant must enter a value before completing the transaction.


Field Name

Description

Configuration Options

Customer

Allows merchants to select or create a customer profile for the transaction.

  • Allow Add New - Enables merchants to create new customers.
  • Enabled - Displays the Customer field in the VT.
  • Required

Email

Captures the customer's email address, often used for receipt delivery.

  • Validate Format - Enforces validation through regex defined in Validation Regex field.
  • Validation Regex - Defines the pattern used to validate the email format.
  • Mask Field - Masks characters for privacy as defined in the Mask Expression field.
  • Mask Expression - Defines the mask pattern.
  • Placeholder Text - Temporary text used to fill space in a design or provide a hint for user input.
  • Enabled - Displays the Email field in the VT.
  • Required

TaxAmount

Enables manual entry of tax unless auto-calculation is used.

  • Auto Calculate - Tax calculates automatically based on percentage defined in Default Rate field.
  • Default Rate - Auto-calculation percentage.
  • Enabled - Displays the Tax field in the VT.
  • Required

PONum

Field for entering a Purchase Order number.

  • Enabled - Displays the PO Number field in the VT.
  • Required

BillingAddress

Displays fields for the customer’s billing address.

  • Only Require AVS Fields
  • Enabled - Displays the Billing Address field in the VT.
  • Required

Phone

Captures the customer’s phone number, with optional masking.

  • Mask Field - Turns masking on/off.
  • Mask Expression - Defines phone formatting mask.
  • Enabled - Displays the Phone field in the VT.
  • Required

ConvenienceFee

Allows entry or automatic calculation of a convenience fee.

  • Auto Calculate - The Convenience Fee is automatically calculated based on the percentage set in the Calculation Percentage field.
  • Calculation Percentage - Convivence fee auto-calculation percentage.
  • Custom Name - Sets the display name for the Convenience Fee field (defaults to Convenience Fee).
  • Custom Description - Sets a custom description displayed under the Convenience Fee field.
  • Read Only - Sets the Convenience Fee field to read only.
  • Default Amount - Sets a preset convivence fee amount.
  • Enabled - Displays the Convenience Fee field in the VT.
  • Required

DutyAmount

Used for entering duty or tariff amounts in Level 3 processing.

  • Default Amount - Sets a preset duty amount.
  • Enabled - Displays the Duty Amount field in the VT.
  • Required

InvoiceNum

Merchant invoice identifier for reporting or Level 2/3 data.

  • Enabled - Displays the Invoice Number field in the VT.
  • Required

Level3Amount

Captures additional Level 3 amount information required by some processors.

  • Default Amount - Sets a preset level 3 amount.
  • Enabled - Displays the Level 3 Amount field in the VT.
  • Required

ShippingAddress

Displays shipping address fields for card-not-present transactions.

  • Default to Same as Billing - Auto-fills shipping fields from the values set in the billing fields.
  • Enabled - Displays the Shipping Address field in the VT.
  • Required

ShippingAmount

Field for entering shipping charges.

  • Default Amount - Sets a preset shipping amount.
  • Enabled - Displays the Shipping Amount field in the VT.
  • Required

TipAmount

Allows entry of tips or gratuities.

  • Default Amount - Sets a preset tip amount.
  • Enabled - Displays the Tip Amount field in the VT.
  • Required

Processing Settings

The Processing section defines how transactions are validated, routed, and settled for the merchant. These settings control required transaction data, duplicate-check behavior, and how Level 2 and Level 3 order-data defaults are applied. Card Verification rules determine how AVS and CVV responses are interpreted. This section also manages auto-settlement preferences, processor profile configurations used for routing transactions to supported processors, and register identifiers that help categorize transaction sources for reporting.

Processing General Settings

Field NameDescription
Require Level2 DataRequires eligible Level 2 card BINs to submit Level 2 data (manually or via order data defaults).
Require Name on CardRequires the cardholder name on all transactions regardless of entry mode.
Require Zip CodeRequires the billing ZIP code on every transaction, regardless of AVS configuration.
Require ShippingRequires the shipping amount to be provided with the transaction.
Enable Force CaptureAllows force-capture transactions without online authorization.

Duplicate Check

Field NameDescription
EnableEnables duplicate-transaction checking for the merchant.
Allow OverrideAllows the merchant to override duplicate-check logic on individual transactions.
Include Invoice NumberIncludes the invoice number as part of the criteria used to determine if a transaction is a duplicate.

Order Data Defaults

Field NameDescription
EnableEnables the usage of order-data defaults for the merchant.
Apply Level2 Defaults to APIAutomatically applies Level 2 data defaults to API-submitted transactions.
Apply Level3 Defaults to APIAutomatically applies Level 3 data defaults to API-submitted transactions.
Apply Level2 Defaults to VTAutomatically applies Level 2 data defaults to Virtual Terminal transactions.
Apply Level3 Defaults to VTAutomatically applies Level 3 data defaults to Virtual Terminal transactions.

Card Verification Settings (AVS & CVV)

Field NameDescription
AV No MatchNeither the street address nor ZIP code match.
AV Partial MatchThe street address matches, but the ZIP code does not.
AV Partial Match IntlStreet address matches, but postal code is not verified or not provided for international transactions.
AV No Match IntlStreet address and postal code do not match for international transactions.
AV Match IntlBoth street address and postal code match for international transactions.
AV ErrorAVS could not be performed due to a system error or invalid data.
AV Match UKBoth street address and postal code match for UK transactions.
AV Not Supported IntlAVS is not supported by the card issuer for international transactions.
AV Intl No MatchAddress information does not match for international transactions.
AV Match Intl BothStreet address and postal code both match for international transactions.
AV Zip Match IntlPostal code matches, but street address is not verified for international transactions.
AV RetryAVS system unavailable or timed out; retry may succeed.
AV Not SupportedIssuer does not support AVS for this transaction.
AV UnavailableAVS information is not available or issuer does not support AVS.
AV Zip Partial Match 9-Digit9-digit ZIP matches, but the street address does not.
AV Zip Match 9-DigitBoth the street address and the 9-digit ZIP code match.
AV Zip Match 5-DigitBoth the street address and the 5-digit ZIP code match.
AV Zip Partial Match 5-Digit5-digit ZIP matches, but the street address does not.
CVV MatchCVV matches.
CVV No MatchCVV does not match.
CVV Not ProcessedIssuer did not process CVV.
CVV Not ProvidedCardholder did not provide a CVV value.
CVV Issuer Not CertifiedIssuer is not certified to validate CVV.
CVV Unable to ProcessIssuer unable to perform CVV verification.

Auto Settlement Settings

Field NameDescription
EnableEnables auto settlement for the merchant. Required for terminal-capture processors in order for transactions to automatically capture and settle.
Send Merchant EmailSends a summary email to the merchant when auto settlement completes.
User Notification TypeDetermines whether only the primary merchant user or all merchant users receive the settlement email notification.
Email Address (add row)Allows additional email addresses to receive settlement notifications when auto settlement completes.

Processor Profiles Settings

Processor Profiles define the merchant’s processor configuration—also known as VAR sheet details—which enable the merchant to process transactions through supported processors (e.g., TSYS, Fiserv). Profiles also specify which payment types the merchant is authorized to accept (Visa, Mastercard, etc.), along with processor-specific identifiers required for routing transactions correctly.

Field NameDescription
Processor Profile (Add)Adds a new processor profile for the merchant.
ProcessorDisplays the processor configuration this profile applies to (e.g., TSYS, Fiserv).
PaymentTypesIndicates which card brands or payment types are supported by this processor profile.
MerchantIdThe merchant identifier used by the processor for transaction routing.
HostBased

Registers

Registers provide a way for merchants to tag transactions by source—such as POS systems, integrations, terminals, or other entry points. In addition to reporting purposes, registers allow merchants to differentiate transaction origin when multiple systems submit payments under a single merchant account.

Field NameDescription
Register (Add)Adds a new register entry for grouping and identifying transaction sources.
Friendly IdA user-friendly identifier for the register.
NameThe register’s name, typically describing the source system or device.
DescriptionAdditional details about the register’s purpose or usage.
EnabledIndicates whether the register is active and available for assignment.

Features

The Features section enables or restricts optional functionality available to the merchant within the gateway. These settings determine whether merchants can configure their own custom fields and hosted payment pages, manage their own fraud controls, use specialized UI features such as authorization editing, and whether the merchant operates as a billing “house account.” This section defines the additional capabilities exposed to merchant users beyond standard transaction processing.

General Features Settings

Field NameDescription
Enable GSA Bin CheckEnables BIN lookup to identify government-issued cards for tax calculation purposes.
Enable Auth EditAllows merchant users to view and edit pending authorizations before capture.

Configuration Limits

Field NameDescription
Allow Custom Field ConfigAllows merchant users to create and manage their own custom fields.
Allow Order Data Defaults ConfigAllows merchant users to configure their own order-data default values.
Allow Fraud Control ConfigAllows merchant users to configure their own fraud-filter settings.
Allow Quick Pay ConfigAllows merchant users to configure QuickPayment.js settings.
Allow Hosted Payment Page ConfigAllows merchant users to configure their hosted payment pages.
Allow Emulator ConfigAllows merchant users to configure their own field emulators.
Allow Fraud LogAllows merchant users to view their fraud-filter logs.

Merchant Billing

Field NameDescription
Is Merchant Billing AccountEnables this merchant to operate as a Merchant Billing “House Account.”

Custom Field

The Custom Field section allows merchants to define their own data fields that appear during transaction entry or in hosted payment pages. These fields can be configured with validation rules, display settings, and reporting visibility to support merchant-specific workflows or data collection needs.

Custom Field Table

Field NameDescription
Custom Field (Add)Creates a new custom field for use in transactions or hosted payment pages.
NameThe label of the custom field as it will appear to the user.
DescriptionA merchant-defined description of the field’s purpose.
EnabledIndicates whether the field is active and available for use.
NumericIndicates whether the field accepts only numeric input.

Add a Custom Field Options

SettingDescription
NameThe display name of the custom field.
DescriptionA description of the field’s purpose or usage.
Form PositionDetermines the field’s display order on forms.
RequiredIf enabled, the field must be completed before submitting the form.
EnabledActivates the custom field for use.
NumericRestricts user input to numeric values.
RegexA custom validation rule using regular expressions.
Regex MessageThe error message shown when the regex validation fails.
Decimal PlacesSets the allowed decimal precision for numeric fields.
Max ValueThe maximum allowable numeric value.
Min ValueThe minimum allowable numeric value.
Max LengthThe maximum number of characters permitted in the field.
Transaction Reports – VisibleDetermines whether the field appears in transaction reporting.
Transaction Reports – ReadOnlyShows the field in reports but prevents editing.
Hosted Payment Pages – VisibleDisplays the field on hosted payment pages.
Hosted Payment Pages – ReadOnlyDisplays the field on hosted pages but prevents the customer from editing it.