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
| Field | Description |
|---|---|
| Name | The primary name of the merchant. This is the display name used throughout the system and required for identification. |
| Custom Identifier | An optional merchant-defined identifier used for custom tracking or external system mapping. |
| Parent Reseller | The reseller under which the merchant is grouped. Determines access visibility and organizational structure. |
| Dba | The merchant's “Doing Business As” name that represents the merchant’s public-facing business name. |
| Is Test | Indicates 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
| Field | Description |
|---|---|
| Primary Contact Name | The name of the merchant’s primary point of contact. |
| Phone | A primary phone number used for merchant communication. |
| Fax | An optional fax number associated with the merchant. |
| Company URL | The merchant's public-facing website or homepage. |
Address List Fields
| Column | Description |
|---|---|
| Address 1 | The first line of the merchant’s street address. |
| City | The city associated with the address. |
| State | The U.S. state or region for the address. |
| Zip | The ZIP or postal code. |
| Mailing | Indicates whether this address is used for mailed communications. |
| Default | Marks 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
| Field | Description |
|---|---|
| Address1 | The first line of the address (street number and street name). |
| City | The city associated with the address. |
| State | State dropdown used to select the merchant’s state or region. |
| Zip | Postal code for the address. |
| Mailing | Flags the address as one used for mailed receipts or notifications. |
| Default | Sets 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 Name | Description |
|---|---|
| Federal Tax Id | The merchant’s tax id. |
| State Tax Id | The merchant's state-issued tax identification number. |
| Sales Tax Id | The merchant’s sales ID tax number. |
| Business Start Date | The date the business originally began operation. |
| Currency | The default operating currency for the merchant. |
| Ownership Type | Specifies 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
| Setting | Description |
|---|---|
| Enable Commercial | Prompts for commercial card data where applicable. |
| Enable GSA | Enables prompts for U.S. Government Services Administration purchasing cards. |
| Enable FSA | Enables prompts for Flexible Spending Account (FSA) cards that require eligible amount verification. |
Transaction Options
| Setting | Description |
|---|---|
| Allow Repeat Sales | Allows a merchant to re-run a previous transaction without re-entering all fields. |
| Allow Refunds | Enables refund transactions in the Virtual Terminal. |
| Enable Email Receipts | Allows 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. |
|
Captures the customer's email address, often used for receipt delivery. |
| |
TaxAmount | Enables manual entry of tax unless auto-calculation is used. |
|
PONum | Field for entering a Purchase Order number. |
|
BillingAddress | Displays fields for the customer’s billing address. |
|
Phone | Captures the customer’s phone number, with optional masking. |
|
ConvenienceFee | Allows entry or automatic calculation of a convenience fee. |
|
DutyAmount | Used for entering duty or tariff amounts in Level 3 processing. |
|
InvoiceNum | Merchant invoice identifier for reporting or Level 2/3 data. |
|
Level3Amount | Captures additional Level 3 amount information required by some processors. |
|
ShippingAddress | Displays shipping address fields for card-not-present transactions. |
|
ShippingAmount | Field for entering shipping charges. |
|
TipAmount | Allows entry of tips or gratuities. |
|
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 Name | Description |
|---|---|
| Require Level2 Data | Requires eligible Level 2 card BINs to submit Level 2 data (manually or via order data defaults). |
| Require Name on Card | Requires the cardholder name on all transactions regardless of entry mode. |
| Require Zip Code | Requires the billing ZIP code on every transaction, regardless of AVS configuration. |
| Require Shipping | Requires the shipping amount to be provided with the transaction. |
| Enable Force Capture | Allows force-capture transactions without online authorization. |
Duplicate Check
| Field Name | Description |
|---|---|
| Enable | Enables duplicate-transaction checking for the merchant. |
| Allow Override | Allows the merchant to override duplicate-check logic on individual transactions. |
| Include Invoice Number | Includes the invoice number as part of the criteria used to determine if a transaction is a duplicate. |
Order Data Defaults
| Field Name | Description |
|---|---|
| Enable | Enables the usage of order-data defaults for the merchant. |
| Apply Level2 Defaults to API | Automatically applies Level 2 data defaults to API-submitted transactions. |
| Apply Level3 Defaults to API | Automatically applies Level 3 data defaults to API-submitted transactions. |
| Apply Level2 Defaults to VT | Automatically applies Level 2 data defaults to Virtual Terminal transactions. |
| Apply Level3 Defaults to VT | Automatically applies Level 3 data defaults to Virtual Terminal transactions. |
Card Verification Settings (AVS & CVV)
| Field Name | Description |
|---|---|
| AV No Match | Neither the street address nor ZIP code match. |
| AV Partial Match | The street address matches, but the ZIP code does not. |
| AV Partial Match Intl | Street address matches, but postal code is not verified or not provided for international transactions. |
| AV No Match Intl | Street address and postal code do not match for international transactions. |
| AV Match Intl | Both street address and postal code match for international transactions. |
| AV Error | AVS could not be performed due to a system error or invalid data. |
| AV Match UK | Both street address and postal code match for UK transactions. |
| AV Not Supported Intl | AVS is not supported by the card issuer for international transactions. |
| AV Intl No Match | Address information does not match for international transactions. |
| AV Match Intl Both | Street address and postal code both match for international transactions. |
| AV Zip Match Intl | Postal code matches, but street address is not verified for international transactions. |
| AV Retry | AVS system unavailable or timed out; retry may succeed. |
| AV Not Supported | Issuer does not support AVS for this transaction. |
| AV Unavailable | AVS information is not available or issuer does not support AVS. |
| AV Zip Partial Match 9-Digit | 9-digit ZIP matches, but the street address does not. |
| AV Zip Match 9-Digit | Both the street address and the 9-digit ZIP code match. |
| AV Zip Match 5-Digit | Both the street address and the 5-digit ZIP code match. |
| AV Zip Partial Match 5-Digit | 5-digit ZIP matches, but the street address does not. |
| CVV Match | CVV matches. |
| CVV No Match | CVV does not match. |
| CVV Not Processed | Issuer did not process CVV. |
| CVV Not Provided | Cardholder did not provide a CVV value. |
| CVV Issuer Not Certified | Issuer is not certified to validate CVV. |
| CVV Unable to Process | Issuer unable to perform CVV verification. |
Auto Settlement Settings
| Field Name | Description |
|---|---|
| Enable | Enables auto settlement for the merchant. Required for terminal-capture processors in order for transactions to automatically capture and settle. |
| Send Merchant Email | Sends a summary email to the merchant when auto settlement completes. |
| User Notification Type | Determines 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 Name | Description |
|---|---|
| Processor Profile (Add) | Adds a new processor profile for the merchant. |
| Processor | Displays the processor configuration this profile applies to (e.g., TSYS, Fiserv). |
| PaymentTypes | Indicates which card brands or payment types are supported by this processor profile. |
| MerchantId | The 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 Name | Description |
|---|---|
| Register (Add) | Adds a new register entry for grouping and identifying transaction sources. |
| Friendly Id | A user-friendly identifier for the register. |
| Name | The register’s name, typically describing the source system or device. |
| Description | Additional details about the register’s purpose or usage. |
| Enabled | Indicates 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 Name | Description |
|---|---|
| Enable GSA Bin Check | Enables BIN lookup to identify government-issued cards for tax calculation purposes. |
| Enable Auth Edit | Allows merchant users to view and edit pending authorizations before capture. |
Configuration Limits
| Field Name | Description |
|---|---|
| Allow Custom Field Config | Allows merchant users to create and manage their own custom fields. |
| Allow Order Data Defaults Config | Allows merchant users to configure their own order-data default values. |
| Allow Fraud Control Config | Allows merchant users to configure their own fraud-filter settings. |
| Allow Quick Pay Config | Allows merchant users to configure QuickPayment.js settings. |
| Allow Hosted Payment Page Config | Allows merchant users to configure their hosted payment pages. |
| Allow Emulator Config | Allows merchant users to configure their own field emulators. |
| Allow Fraud Log | Allows merchant users to view their fraud-filter logs. |
Merchant Billing
| Field Name | Description |
|---|---|
| Is Merchant Billing Account | Enables 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 Name | Description |
|---|---|
| Custom Field (Add) | Creates a new custom field for use in transactions or hosted payment pages. |
| Name | The label of the custom field as it will appear to the user. |
| Description | A merchant-defined description of the field’s purpose. |
| Enabled | Indicates whether the field is active and available for use. |
| Numeric | Indicates whether the field accepts only numeric input. |
Add a Custom Field Options
| Setting | Description |
|---|---|
| Name | The display name of the custom field. |
| Description | A description of the field’s purpose or usage. |
| Form Position | Determines the field’s display order on forms. |
| Required | If enabled, the field must be completed before submitting the form. |
| Enabled | Activates the custom field for use. |
| Numeric | Restricts user input to numeric values. |
| Regex | A custom validation rule using regular expressions. |
| Regex Message | The error message shown when the regex validation fails. |
| Decimal Places | Sets the allowed decimal precision for numeric fields. |
| Max Value | The maximum allowable numeric value. |
| Min Value | The minimum allowable numeric value. |
| Max Length | The maximum number of characters permitted in the field. |
| Transaction Reports – Visible | Determines whether the field appears in transaction reporting. |
| Transaction Reports – ReadOnly | Shows the field in reports but prevents editing. |
| Hosted Payment Pages – Visible | Displays the field on hosted payment pages. |
| Hosted Payment Pages – ReadOnly | Displays the field on hosted pages but prevents the customer from editing it. |
Updated 2 months ago
