Cardknox Merchant Portal User Guide

Overview

Watch Video

The Cardknox Merchant Portal is a revolutionary, user-friendly online platform for seamless management of Cardknox payment processing accounts. The intuitive and fluid interface features user-friendly, robust tools for report creation, batch and transaction viewing, payment processing, and more, making it easier than ever to keep a finger on the pulse of your business. With the help of our diverse search filters, you can seamlessly locate transactions or generate custom-made reports that pinpoint exact data, all in a lot less time.

Note that additional features and functionality to further enhance the user experience are currently in development. Customer profile management capabilities, customizable recurring billing options, and portal user management are just a few of several upcoming enhancements.

The following describes the main features of the Cardknox platform. It contains information about features within the application including screen samples, field descriptions, and procedures for managing your transactions and customer information.

Cardknox Merchant Portal

When you sign in to the Cardknox Merchant Portal, the application opens with the Welcome to Cardknox Portal screen and displays your company’s Dashboard. The Dashboard gives you a quick overview of what’s happening with your business and contains the most important data from the features you currently use.

Use the menu tabs on the left side of the welcome screen to navigate through the application and take action on your transaction data.

Tips:
  • After 30 minutes of inactivity on any tab, the application closes. If you close your browser, the system clears your session after 15 minutes, and if you open a new browser window, you must log in again.
  • You can click the Collapse Menu button to collapse the menu bar at the left-hand side of any page, giving you more room to view data. Click the button again to expand the menu bar.

Dashboard

The Dashboard tab displays business information in graphical format. The Dashboard tab opens yesterday’s data displayed by default. Interactive graphics give you an at-a-glance view of your company’s current financial details on one screen to help you spot trends and monitor activity by transaction type, such as transaction counts and amounts. See the item description table below for more information about these features.

Dashboard Tab

Dashboard Tab Item Descriptions

Item Description
Gateway status Displays a message about the status of an event such as a system outage.
Notifications button Click this button to display notification messages.

Account name Displays the name of the account.

Click the arrow to open a list of your accounts.

Type your search criteria in the search field or click an option in the list.

User button Displays your account’s email address.

Click this button or arrow to log out of the Cardknox Portal.

Calendar button Click this button and choose a day from the list, or select Custom from the list and enter a date range on the calendar and click Apply to display graphical images of the features you currently use.

If you choose Custom, the following edits are in place:

  • The date you enter cannot exceed 7 days from today’s date
  • You must enter a valid date range (i.e., 2018 to 2019, not 2019 to 2018).
New Transaction Allows you to create a new transaction
Gross revenue Displays a graph showing sales, credit, and totals information for the date you select.

Hover your pointer over a point on the graph to view monetary details by time and date.

Transaction activity Displays the calculated sales, credit, total, and average transaction amounts for the date you select.
Sales Summary Displays sales summary information by product.

Hover your pointer over the graphic to view total transaction count and amount information.

Credit Summary Displays credit summary information by product.

Hover your pointer over the graphic to view total transaction count and amount information.

Dashboard Displays your company’s main Dashboard based on the features you select to view.
Transactions Allows you to view or take action on existing transactions.
New + Allows you to create a new transaction
Send Payment Request Allows you to send a payment request link to your customers.
Quick Reports Allows you to view or take action on reports.
Gift Report Allows you to view or take action on gift reports.
Batches Allows you to view or take action on batches.

Note: If your account does not support batches, this tab is not visible.

Customers Allows you to view or take action on customer records.
New + Allows you to create a new customer.
Recurring Schedules Allows you to view or take action on recurring payment schedules.
Company latest news Click this link to access the Cardknox Newsroom page to read the latest press releases and news articles.
Settings Allows you to modify selected portal settings.
Help Click this link to expand the Help menu.
Contact us Click this link to find information about how to contact us for merchant and partner sales information, software integration, and technical support.
FAQ Click this link to access the Cardknox FAQ page.
User Guide Click this link to access the Cardknox Merchant Portal User Guide documentation.
Remote Support Click this link to access the Cardknox online support and collaboration portal.

Transactions

Watch Video

The Transactions tab provides a quick overview of your existing transactions and enables you to view and manage all your transaction data from one page.

By default, the Transactions tab opens with the last 7 days of transaction records displayed. Click on “Last 7 Days” to select a different time period or define a custom time period.

At the top of each column, you can type in criteria text to filter the transaction data. For example, to see only transactions for April 3, 2020, type in 04/03/2020 in the text field at the top of the Date column.

Upon clicking a transaction reference number, you can view all transaction information— including the transaction date and time, amount, cardholder’s name, payment card account number and card type, approval status, transaction type, and a description of the transaction.

The Transactions tab helps you manage your business by enabling you to easily perform the following actions.

  • Process a new transaction
  • Search for a transaction
  • Export a transaction
  • Modify a transaction
  • Apply voids and refunds
  • Link a transaction to a customer
Tips:
  • The Transactions tab opens with the last 7 days of data displayed by default.
  • Enter search criteria in the fields next to the column headings to search for a transaction.
  • Click the arrow to the right of any column heading to sort the column.
  • Click the arrow to the left of any row to expand the row and display transaction detail information.
  • Certain column headings display a screen tip when you hover your mouse over the column name.
  • Click between column headers to select and resize any column.
  • Customize your page view by selecting the columns you want to appear by default.

Note: Only a partial screen sample is displayed below. All fields are documented in the following item description table.

Transactions Tab

Expanded Search Features

Certain fields include drop-down menus you can use to narrow the results of your display settings. For example, the Card Type field menu displays a list of available card types. Click the arrow in the column headings for the following fields to open a menu with more search options:

  • Card Type
  • Command
  • Currency
  • Entry Method
  • Payment Method
  • Result
  • 3D Secure Result
Transactions Tab Item Descriptions

Item Description
Calendar button Click the calendar button and choose an option from the list.

Valid values are as follows:

  • Yesterday
  • Today
  • Last 7 Days
  • Last 30 Days
  • Last 60 Days
  • Last 90 Days
  • Custom

If you choose Custom, the system opens a calendar you can use to select a date range and a time range. The following edits are in place:

  • The date you enter cannot exceed 7 days from today’s date
  • You must enter a valid date range (i.e., 2018 to 2019, not 2019 to 2018).
  • You can display up to 100 days of data.

The system displays an error message if you enter an invalid date or date range.

Select a date range in the calendar fields, select a time range in the From and To fields, and click Apply.

Filter Click this button to select one or more filter options from the list.

When you choose a filter, the system opens either a menu with an additional list of criteria to select, or a text box displaying information about what filter criteria to enter.

For example, if you select Card number, the text box informs you to enter the Last 4 digits of the payment card number. If you select Status, a menu displays the options Approved, Declined, Error, and Auth you can choose.

Valid values are as follows:

  • Card Number
  • Cardholder Name
  • Reference Number
  • Invoice
  • Amount
  • Status
  • Disable date range
  • Advanced

Note: If you select Advanced, the system opens an additional list of options.

  • Advanced
    • CVV Result
    • AVS
    • Transaction Type
    • Card Type
    • Batch
    • Company
    • Description
    • Email
    • Auth Code
    • Terminal Number
    • PO Number
    • Order ID
    • Custom Fields
    • Source Key

Note: If you select Card Type, the system opens a menu allowing you to select multiple payment card types.

Click Reset all to clear all selected filters in the Filters list or click Done to close the form and save your changes.

Reset filter Click this link to reset all filters.

When you click Reset filter, the system:

  • Clears all selected filters in the Filters list
  • Clears all selected options in the Settings button Available Columns list and reverts to the default column page view
New transaction Click this button to open the Add new transaction dialog box and create a new transaction.
Download button Click this button to choose whether to export the current view or all transactions in CSV or Quickbooks format.

Print Click this button to print a transaction report.

Select Current view (PDF) to open a dialog box and print a report of the current view.

Select All transactions (PDF) to open a dialog box and print a report of all transactions.

Settings button Click this button to open a set of options to customize your page view as follows:

  1. In the Available Columns list, select the columns you want to appear on your Transactions page by default.
  2. Select the Save Selection checkbox and click Done to save the columns you selected as the default view.
  3. Alternatively, click Settings; the system opens the Report Settings subtab with the Transaction Report displayed.
  4. In the Show in Report section, select the columns you want to appear on your Transactions page and click Save; the columns you selected are saved as the default view.

The columns in this list are in the same order as the fields in the Transaction Report list on the Report Settings subtab of the Settings tab.

Note: If you click the Reset filter link, the system clears all selected options in the Available Columns list and reverts to the default column page view.

Show/hide button Click the right arrow to show the date range or click the down arrow to hide the date range.
Load more Displays options to select the number of transactions to display on the page.

Valid options are as follows:

  • 50
  • 100
  • 500
  • 1000
  • All
Total Approved Displays the count and total amount of all Approved and Auth-only transactions on the current page in the currency you select.

Note: Only US dollars and British pounds are currently supported.

Count Displays the number of transactions on the current page.
Total by Card Click this link to open the Total by Card dialog box and view the total amount and count of Approved transactions by card type.

Click the Download button to export the current view in CSV format.

Create a New Transaction

You can quickly process a new transaction by either selecting Transactions from the navigation menu on the left side of the screen or clicking the New Transaction button at the top right side of the screen. Click either option to open the Add New Transaction dialog box to create a new transaction.

Tips:
  • When you click New Transaction, the system populates fields in the Add New Transaction dialog box with any saved customer and transaction information
  • The * symbol indicates a required field.
  • Click the Expand view button at the top of the dialog to display all fields.
  • 3D Secure is designed for e-commerce transactions, either via a website or PaymentSITE. If you have this feature enabled and 3D Secure disapproves a transaction, the system declines the payment. However, you can choose to override 3D authentication for a declined payment by using the Disable 3DS Verification option.

Add New Transaction Expanded View

Complete the fields as described in the following table to manage your transaction information.

Add New Transaction Item Descriptions

Item Description
Transaction Settings Click this link to open the Transaction Required Fields subtab of the Settings module to modify transaction field settings.
View button Click this button to open the Transaction Fields subtab of the Settings module to modify transaction field settings.
Expand view button Click this button to expand all rows and view transaction details before processing.
Amount* Enter the transaction amount. Required field for both credit card and check payments.
Convenience Fee Select this checkbox to include the convenience fee.

If you select the Allow Customer Option to Include/Exclude Conv Fee checkbox in the Transaction Fields section of the Settings tab, the Convenience Fee checkbox is selected by default.

If you leave the Allow Customer Option to Include/Exclude Conv Fee checkbox in the Transaction Fields section of the Settings tab blank, the Convenience Fee checkbox does not appear and the convenience fee is automatically added.

Exclude Convenience Fee Select this checkbox to exclude the convenience fee.
Credit Card The following fields appear only when you select the Credit Card tab.
Transaction Type* Click the arrow and select a transaction type.

Valid values are as follows:

  • Charge
  • Auth Only
  • Refund
  • Post Auth
  • Gift: Issue
  • Gift: Redeem
Card Number* Enter the customer’s 16-digit payment card number. Required field.
Exp Date* Enter the payment card’s expiration date in MM/YY format. Required field.
Security Code Enter the payment card’s CVV number.

The CVV is required only for new transactions.

Check The following fields appear only when you select the Check tab.
Account Type Click the arrow and select an account type.

Valid values are as follows:

  • Checking
  • Savings

Account Name* Enter the name on the account. Required field.
Routing Number* Enter the account’s bank routing number. Required field.
Account Number* Enter the account number. Required field.
Terms* Select the I Agree checkbox. Required field.
The following fields appear on both the Credit and Check tabs.
Use different payment method Click this link to create a new payment method.
Use the same payment method Click this link to open the fields associated with the same payment method.
Email Enter the customer’s email address.
Send Receipt Select this checkbox to send a receipt to the customer.

If you select the Send The Customer A Receipt By Default checkbox in the Transaction Fields section of the Settings tab, the system automatically selects this checkbox by default.

Disable 3DS Verification Select this checkbox to disable 3D Secure verification.

If you choose this option and the payment declines, the system bypasses 3D authentication and allows you to resubmit the transaction.

Send me a copy Select this check box to send a copy of the transaction to the customer.

If you select the Send Me A Receipt By Default checkbox in the Transaction Fields section of the Settings tab, the system automatically selects this checkbox by default.

Billing Information This section contains the same fields as the Shipping Info section. If you select the Same As Billing? checkbox, the shipping information fields collapse.

Complete the following fields:

  • First Name
  • Last Name
  • Company
  • Address
  • City
  • State
  • Zip
  • Country*
  • Phone Number
  • Same as Billing?
Shipping Info
  • Same as Billing?

This section contains the same fields as the Billing Information section.

Transaction Details Complete the following fields, if applicable:

  • Invoice
  • PO Number
  • Description
  • Order Id
Custom Fields Complete any custom fields, if applicable.
Expand All Click this button to expand all fields.
Collapse All Click this button to collapse all fields.
Save As Customer Select this check box to create a new customer while adding a new transaction.
Process Click this button to process the customer’s payment.

Display Transaction Details

You can view transaction details by clicking the arrow to the left of a transaction reference number showing transaction information, billing information, and shipping information. In addition, options enable you to void or refund the transaction. You can also create a new transaction from either an Approved or Declined transaction, or create a new customer record.

Transaction Details

Complete the fields as described in the following table to view transaction details or take action on the transaction.

Transaction Details Item Descriptions
Item Description
Transaction Information Displays the status of the transaction and the following information:

  • Amount – Amount of the transaction
  • Entered Date – Date and time the transaction was entered
  • Account Number – Last 4 digits of the account number
  • Payment Type – Credit card or check
  • Transaction Type – AuthOnly, Capture, Sale, Save
  • AVS – AVS result
  • Transaction Description – Transaction details
  • Processing Details – Click this link to display detail information
Printer button Click the printer button to open a dialog box and print the transaction receipt.

The transaction receipt contains includes the following information:

Receipt Header Information:

  • Company name
  • Company address
  • Company phone number

Processing Information:

  • Amount
  • Date
  • Transaction type
  • Status

Card Information:

  • Card type
  • Card expiration
  • Card number
  • Cardholder name

Additional Information:

  • Entry method
  • Payment method
  • Reference number
  • Payment type
  • Authorization code

Signature:

  • Customer signature line

Email button Click this button to open a dialog box to send an email to the customer with the transaction receipt.

Click the Send me an email of this receipt checkbox to receive a copy of the receipt.

Download button Click this button to export the transaction in CSV format.
View button Click this button to view the transaction receipt.

The transaction receipt contains includes the following information:

  • Transaction Reference Number
  • Company Name
  • Company Address
  • Phone Number

Transaction Information:

  • Amount
  • Billing Information
  • Shipping Information
  • Entered Date

Transaction Detail:

  • Payment type
  • Transaction type
  • Card type
  • Transaction entry method
  • Card number
  • Card expiration
  • Ref # – Reference number

Click the Printer button to open a dialog box and print the transaction receipt.

Click the Email button to open a dialog box to send an email message.

Refund Click this button to open the Refund dialog box.

Complete the fields to issue either a full or partial refund. Click Refund to process the refund, or click Cancel to clear the form and discard your changes.

A fully refunded transaction displays the badge REFUNDED.

A partially refunded transaction displays the badge PARTIALLY REFUNDED.

  • Hover your pointer over the partially refund badge to view a tooltip message showing the amount of the full or partial refund.
  • Hover your pointer over the Refund button to view a tooltip message that the transaction was partially refunded.

Adjust Click this button to open the Adjust dialog box.

Complete the fields to issue an adjustment.

Click Adjust to process the adjustment or click Cancel to clear the form and discard your changes.

New Transaction Click this button to open the Add new transaction dialog box and create a new transaction.

Link a Customer to a Transaction

You can link a new or existing customer record to a transaction by clicking the Add Customer button in the Transaction Information section of the Transactions screen.

When you click Add Customer, you’ll need to choose New Customer or Existing Customer:

Link Transaction To Customer Popup

  • Link to a new customer —See the “Customers” section of this guide.
  • Link to an existing customer —See the steps below.

After you click the Existing Customer button, the system displays the Link transaction to an existing record dialog.

  1. Use the filter fields at the top of the dialog to locate the customer record:
  2. Click on the customer record to select it.
  3. Click the Save button.

To view the linked transaction, open the customer record and view the Transaction History tab.

Quick Reports

Watch Video

The Quick Reports tab enables you to quickly and easily generate a variety of on-demand transaction reports to help you analyze and manage transaction activity. Options on this tab allow you to sort transactions by date, reference number, cardholder name, invoice number, or amount. You can also refine your report criteria by transaction type and transaction status.

Additional options on the Quick Reports tab enable you to choose from a set of predefined report categories or use over a dozen filters to create and download customized reports.

Options on the Reports page enable you to do the following:

  • Generate predefined Quick Reports
  • Create custom reports with the Create new report feature
  • Save an existing custom report with a new name for future use
  • View, download, print, edit, and delete saved reports

Reports Page

Complete the following steps to create a custom report.

  1. In the Create new report section, choose options from the following fields:
    • Select Date
    • View / Sort By
    • Transaction Type
    • Transaction Status
  2. Click Add filters and select additional report options.
  3. Click Save Report; the Custom Saved Report dialog box opens.
  4. Type a name for the report in the Report Name field and click Save; the system saves the report and adds it to the Custom Saved Reports section.

Create new report

Custom Saved Reports

Complete the fields as described in the following table to manage your reports information.

Reports Page Item Descriptions

Item Description
Hide filters Click this link to collapse the filters list.
Print Click this button to open a dialog box and print the transaction report.
Download Click this button to export the report in CSV format
Save Report Click this button to save the custom report.
View Report Click this button to view the transaction information used to generate the report as displayed on the Transactions tab.
Custom Saved Reports Displays your custom reports.

When you create a custom report and click the Save Report button, the system saves the report and adds it to the Custom Saved Reports list (at the top right-hand section of the page) so you can access it later.

(Customer report name) When you create a custom report and click the Save Report button, the system saves the report and adds it to the Custom Saved Reports list so you can access it later.
Preview button Click this button to view the transaction information used to generate the report as displayed on the Transactions tab.
Download button Click this button to export the transaction in CSV format.
Edit button Click this button to open the Add Filters list and update the custom report fields.
Delete button Click this button to delete the custom report.
Quick Reports This section contains options to create reports using predefined report categories. The default date range is the last 30 days.

Valid predefined report options are as follows:

  • Approved, by source key
  • Auths, by source key
  • Errors by date
  • Sales by date
  • Sales by Custom01
  • Sales by batch number
  • Refunds by amount
  • Sales by amount
Preview button Click this button to view the transaction information used to generate the custom report as displayed on the Transactions tab.
Download button Click this button to export the transaction in CSV format.

Gift Report

The Gift Report tab includes the following three reports to help you track and manage your gift cards all on one page:

  • Activity
  • Summary
  • Liability

These reports give you a quick overview of gift card information such as transaction reference number, transaction date and time, amount, gift card number, location, gift card type (Issue or Redeem), and any custom fields you created. You can also download and print report results.

The Gift Report tab opens with the Activity report.

Tips:
  • You can navigate between reports by clicking the toggle-through report titles at the top left side of the page.
  • Click between column headers to select and resize any column.
  • You can search for transactions by gift card number (if one exists) within a date range.

Activity Report

The Activity report shows today’s data by default and displays a list of all reports in your database.

Activity Report

Activity Report – Expanded

Complete the fields as described in the following table to manage your gift card report information.

Activity Report Item Descriptions

Item Description
Calendar icon Click the calendar button and choose a day from the list.

Valid values are as follows:

  • Today
  • Yesterday
  • This month
  • Last 7 Days
  • Last 30 Days
  • Last 60 Days
  • Last 90 Days
  • Custom

The default setting is Last 90 days.

Note: If you select Custom, the system opens a calendar. Select a date range and click Apply.

Search by Gift Card number Type a gift card number and press Enter to search by gift card number.
Advanced Filter Click this link to select one or more filter options from the list.

When you choose a filter, the system opens a text box displaying information about what filter criteria to enter.

Valid values are as follows:

  • Amount
  • Reference Number

Click Reset all to clear all filters or click DONE to close the form and save your changes.

Filter icon Click the filter button to select one or more filter options from the list.

When you choose a filter, the system opens a text box displaying information about what filter criteria to enter.

Valid values are as follows:

  • Amount
  • Reference number
  • Gift Card Number

Note: If you choose the Gift Card Number option, enter the gift card number and select a day or date range from the calendar.

Click Reset all to clear all filters or click DONE to close the form and save your changes.

Download button Click this button to export the current view or all gift card transactions in CSV format.
Print button Click this button to open a dialog box and print a gift card report.
Reference Number Displays the gift card transaction reference number.
Gift Card Number Click the gift card number to view a breakdown of activity for this gift card.

  1. Type a gift card number in the search field and click Apply to display the remaining gift card balance.
  2. Click the Export button to download a report of all gift cards in CSV (Excel) format.
  3. Click the Print button to open a dialog box and print a report of the current view.
Amount Displays the gift card transaction amount.
Cardholder Name Displays the cardholder’s name.
Date and Time Displays the entered date and time.
Location Displays the location.
Command Displays the command.
Invoice Displays the invoice number.
Custom 01 Displays the custom search criteria.
Count Displays the number of items on the current page.
Amount Displays the total amount of all transactions.

 

Summary Report

The Summary report displays summary gift card information by date. The report shows the total dollar amount for all transactions on a specific date or within a date range you select. Use the search fields to search for a different gift card.

Summary Report

Complete the fields as described in the following table to view gift card summary information and generate a report of the totals.

Summary Report Item Descriptions

Item Description
Calendar button Click the calendar icon and choose a day from the list.

Valid values are as follows:

  • Today
  • Yesterday
  • This month
  • Last 7 Days
  • Last 30 Days
  • Last 60 Days
  • Last 90 Days
  • Custom

The default setting is Last 90 daysv.

Note: If you select Custom, the system opens a calendar. Select a date range and click Apply.

Download button Click this button to export the current view or all gift card transactions in CSV (Excel) format.
Print button Click this button to open a dialog box and print a gift card report.
Location Displays the branch location of the business.
Transaction Count Displays the number of transactions.
Total Amount Displays the total gift card amount.
Parent Location Displays the location of the general business, including all branches, if applicable.
Count Displays the number of items on the current page.
Amount Displays the total amount of all transactions.

Liability Report

The Liability report displays the balance remaining on each individual gift card.

Liability Report

Complete the fields as described in the following table to view gift card balances and generate a report of all liabilities.

Liability Report Item Descriptions

Item Description
Download button Click this button to export the current view or all gift card transactions in CSV (Excel) format.
Print button Click this button to open a dialog box and print a gift card report.
Gift Card Number Displays the gift card number.
Remaining Balance Displays the balance remaining on the gift card.
First Name Displays the customer’s first name.
Last Name Displays the customer’s last name. Required field.
Email Displays the customer’s email address.
Count Displays the number of items on the current page.
Remaining balance Displays the total remaining balance of all gift cards.

FraudWatch Report

The FraudWatch report enables you to monitor your payment and gift card transactions for possible fraudulent activity.

Tip:
  • Use the search fields at the top of each column to perform another search.

FraudWatch Report

 

FraudWatch Report Item Descriptions

Item Description
Calendar button Click this button and choose a day from the list.

Valid values are as follows:

  • Yesterday
  • Today
  • Last 7 Days
  • Last 30 Days
  • Last 60 Days
  • Last 90 Days
  • Custom

Note: If you select Custom, the system opens a calendar. Select a date range and click Apply.

Filter button Click this button to select one or more filter options from the list.

When you choose a filter, the system opens a text box displaying information about what filter criteria to enter.

Click Reset all to clear all filters or click Done to close the form and save your changes.

Export Click this button to export the current view or all transactions in CSV (Excel) format.
Print Click this button to open a dialog box and print a customer report.
Ref # Displays the reference number.
Date Displays the transaction date.
Amount Displays the amount of the transaction.
Account # Displays the cardholder’s account number.
Cardholder Name Displays the cardholder’s name.
Invoice Displays the invoice number.
Status Displays the status.

Valid values are as follows:

  • Not Guaranteed
  • Guaranteed
Status Details Displays the status details.

Batches

Watch Video

The Batches tab enables you to easily view and manage your open and closed batch transactions.

Note: This tab is not visible for accounts that do not support batches.

The Batches tab opens in the Closed Batches view with yesterday’s data displayed by default and provides an overview of your batch transactions by date, including sales, credit, transaction total counts and amounts. Closed batches show the date the batch closed, and open batches show the date range for all open batches. Interactive graphics give you an at-a-glance view of your batch details to help you spot trends and view sales and credit summary information by card type. The Batches tab also provides batch detail information.

In addition, the Breakdown by Card feature helps you manage your batch information by enabling you to view a breakdown of payment card types for multiple batches. It provides a breakdown of counts and amounts for sales, credit, voids, and totals by payment card type, and gives you the option to download and print a report of breakdown details. See the item description table below for more information about these features.

Tips:
  • You can view either closed or open batches by clicking Closed Batches and Open Batches at the top left side of the page.
  • The calendar feature is disabled for open batches.

Batches Tab – Open Batches

Complete the fields as described in the following table to manage your batch transaction information.

Batches Tab Item Descriptions

Item Description
Menu button Click this button to open the action menu.

  • Click Export to export the current view in CSV (Excel) format.
  • Click Close current batch to close the page.
Closed Batches Click this link to view all closed batches for a selected date or date range.
Open Batches Click this link to view all open batches.

Note: If you choose this view, the system disables the calendar function and displays open batches only.

Calendar button Click this button and choose a day from the list. This feature is enabled for closed batches only.

Valid values are as follows:

  • Yesterday
  • Today
  • Last 7 Days
  • Last 30 Days
  • Last 60 Days
  • Last 90 Days
  • Custom

Note: If you select Custom, the system opens a calendar. Select a date range and click Apply.

Batch Number Type a batch number to view all batches within a selected date range.
Batch summary date range Displays the date range you selected.
Breakdown by Card Click this link to open the Breakdown by Card dialog box and view totals by card type.
Sale Displays the total amount and count of sales transactions.
Void Displays the total amount and count of voided transactions.
Credit Displays the total amount and count of credit transactions.
Total Displays the total amount and count of both sales and credit transactions.
Batches Details This section displays batch detail information.
ID # Displays the batch ID number.

Click the arrow to expand the row to view a breakdown by card type for this batch.

Close Date and Time Displays the date and time the batch closed.
Sale Displays batch sales amount information.
Void Displays open batch void information.
Credit Displays credit amount information.
Batch Total Displays total batch sales and credit amount information for open and closed batches.
View button Click this button to open the Transactions tab and view the transactions in this batch.

When you click this button in the Closed Batches view, the system opens the Transactions tab in a new browser window and displays batches based on the filters you select.

Print button Click this button to open a dialog and print the batch transaction.
Sale Summary by Card Type Displays sales summary information by product.

Hover your pointer over the graphic to view detailed sales transaction amount and count summary information.

Credit Summary by Card Type Displays credit summary information by product.

Hover your pointer over the graphic to view detailed credit transaction amount and count summary information.

View Batch Transactions Click this link to open the Transactions tab and view the transactions in this batch.

When you click this link in the Closed Batches view, the system opens the Transactions tab in a new browser window and displays batches based on the filters you select.

Total Displays total batch sales and credit amount information for open and closed batches.
View Batch Transactions Click this link to open the Transactions tab and view the transactions in this batch.

When you click this link in the Closed Batches view, the system opens the Transactions tab in a new browser window and displays batches based on the filters you select.

 

View Totals by Card Type

You can view more batch details on the Breakdown by Card page.

View Totals by Card Type

 

Breakdown by Card Dialog Box Item Descriptions

Item Description
Breakdown by Card (MM/DD/YYYY – MM/DD/YYYY) Displays the date range you selected.

Note: If you choose the Open Batches view, the system displays open batches only.

Print button Click this button to open a dialog and print the breakdown by card.
Download icon Click this button to export the breakdown by card type in CSV (Excel) format.
Card Type Identifies the payment card type.

Valid card types are as follows:

  • American Express
  • Discover
  • EBT
  • Mastercard
  • Visa
Sale Displays the amount and transaction count for sales transactions for the card type.
Void Displays the amount and transaction count for voided transactions for the card type.
Credit Displays the amount and transaction count for credit transactions for the card type.
Total Displays the total amount and transaction count for both sale and credit transactions for the card type.
Close Click this button to close the dialog.

Disputes

Cardknox Go merchants use the Disputes feature to manage active disputes. To display the Disputes tab in the left-hand menu, select the Show ‘Disputes’ Tab in the Cardknox Go Settings section of the Transaction Settings subtab of the Settings tab.

Disputes Tab Item Descriptions

Item Description
Calendar icon Click the calendar button and choose a day from the list.

Valid values are as follows:

  • Today
  • Yesterday
  • This month
  • Last 7 Days
  • Last 30 Days
  • Last 60 Days
  • Last 90 Days
  • Custom

The default setting is Last 90 days.

Note: If you select Custom, the system opens a calendar. Select a date range and click Apply.

Filter Click this button to select one or more filter options from the list. When you choose a filter, the system opens a text box displaying information about what filter criteria to enter.

Valid values are as follows:

  • Dispute Amount
  • Cardholder Name
  • Reference Number

Click Reset all to clear all filters or click Done to close the form and save your changes.

disputes-two

Customers

Watch Video

The Customers tab enables you to easily manage your customer information.

The Customers tab shows a list of all transaction records. By clicking a transaction reference number you can display transaction information including the transaction date and time, amount, cardholder’s name, payment card account number and card type, approval status, transaction type, and a description of the transaction. You can apply filters to pinpoint the type of transaction data you want to as well as using additional options to take action on a transaction and to create a new transaction or new customer record.

You can use this tab to perform the following actions.

      • Add a new customer record
      • View existing customer details
      • Search for a customer
      • Export or print customer information
      • Update customer payment methods
      • Update customer payment recurring schedules
      • Create a new customer record using a short form
Tips:
  • The Customers tab opens with today’s data displayed by default.
  • Use the search fields at the top of each column to perform another search.
  • Click the arrow to the right of any column heading to sort the column.
  • Click the arrow to the left of any row to expand the row and display customer detail information.
  • Click between column headers to select and resize any column.

Note: Only a partial screen sample is displayed. All fields are documented in the item description table below.

Customers Tab

Complete the fields as described in the following table to manage your customer information.

Customers Tab Item Descriptions

Item Description
Filter Click this button to select one or more filter options from the list.

When you choose a filter, the system opens a text box displaying information about what filter criteria to enter.
Valid values are as follows:

  • Customer ID
  • Customer #
  • Company
  • First Name
  • Last Name
  • Street
  • City
  • State (United States) Province (Canada)
  • Zip (United States) Postcode (Canada)
  • Phone Number
  • Email

Click Reset all to clear all filters or click Done to close the form and save your changes.

New Customer Click this button to open the Add a new customer dialog box and add a new customer.
Download button Click this button to export the current view or all customers in CSV format.
Print button Click this button to open a dialog box and print a customer report.
Settings button Click this button to open a set of options to customize your page view as follows:

  1. In the Available Columns list, select the columns you want to appear on your Customers page by default.
  2. Select the Save Selection checkbox and click Done to save the columns you selected as the default view.
  3. Alternatively, click Settings; the system opens the Report Settings subtab with the Customer Report displayed.
  4. In the Show in Report section, select the columns you want to appear on your Customers page and click Save; the columns you selected are saved as the default view.

The columns in this list are in the same order as the fields in the Customer Report list on the Report Settings subtab of the Settings tab.

Note: If you click the Reset filter link, the system clears all selected options in the Available Columns list and reverts to the default column page view.

New transaction Click this button to open the Add New Transaction dialog box and add a new customer record.
Send payment request Click this button to send a payment request.

The system opens the Send Payment Request page and prefills the Payment Fields section with previously saved payment information.

Delete customer Click this button to delete the customer record.

Display Customer Details

You can view customer details by clicking on a customer row. This expands the view and opens the customer details section on the right-hand side of the screen. Cardknox highlights the currently select customer in blue:

Customer Details

Options in this section enable you to update a customer’s account profile information, payment method, and recurring schedule, as well as view other transactions linked to the customer.

Tips:
  • Click another Schedule Name to display the customer details for a different customer’s recurring payment schedule without having to close the expanded view.

Complete the fields as described in the following table to view customer details or take action on the record.

Customer Details Item Descriptions

Item Description
General This section contains general customer information.
Customer # Enter the customer’s reference number.
Note Free-form text field for additional customer information.

Type a note then press Save to save your changes. To add another note, either type a new note after an existing one or type over the existing note.

Email Address Enter the customer’s email address.
Billing Information Contains billing information fields.
First Name Enter the customer’s first name.
Last Name Enter the customer’s last name.
Company Enter the company name.
Address 1 Enter the first line of the customer’s address.
Address 2 Enter the first line of the customer’s address.
City Enter the customer’s city.
State Enter the customer’s state.
ZIP Enter the customer’s postal code.
Phone Number Enter the customer’s phone number.
Mobile Phone Number Enter the customer’s mobile phone number.
Shipping Information Contains shipping information fields.
Mobile Phone Number Enter the customer’s mobile phone number.
Same as billing Select this checkbox to use the same address for shipping as billing.
Custom Fields This section contains user-defined fields.
Custom01 – Custom20
Add Custom Field Click this link to add a new custom field.
Save Click this button to save your changes.
Close Click this button to close the tab.
Payment Method This section contains payment method fields.
Credit Card Click this link to display the customer’s available credit card payment methods.
Set To Default Select this checkbox to set this payment method as the default payment method.
Remove Card Select this checkbox to remove the payment card.
Exp Date * Enter the payment card’s expiration date in MM/YY format. Required field.
Address Enter the customer’s address.
Cardholder Zip Enter the customer’s ZIP Code.
Save Click this button to save your changes.
Close Click this button to close the tab.
Add Card Click this button to open additional credit card payment method fields.
Customer ID Displays the customer ID number.
Payment Name Enter the name of the payment method.
Cardholder Name Enter the cardholder’s first and last name.
Card Number* Enter the 16-digit payment card number. Required field.
Check Click this link to display the customer’s available check payment methods.
Set To Default Select this checkbox to set this payment method as the default payment method.
Add Check Click this button to open additional check payment method fields.
Delete button Click this button to remove the check.
Payment Name Enter the name of the payment method.
Account Name* Enter the name on the account. Required field.
Routing Number* Enter the account’s bank routing number. Required field.
Account Number* Enter the account number. Required field.
Recurring Schedule This section contains recurring schedule fields.
Add Recurring Schedule Click this button to open additional recurring payment schedule fields.
Active Click this button to indicate whether the recurring payment schedule is active.

This button only appears in existing transactions.

Preview button Click this button to open the Schedule preview dialog box. See Customers Tab Item Descriptions for more information.

This button only appears in existing transactions.

Remove Schedule Select this checkbox to remove the recurring schedule.
Schedule Name Enter a name for the recurring payment schedule.
Save As Template Select this checkbox to save the recurring schedule as a template.
Start Click this button and select a recurring payment start date.
Description Enter a description for the recurring payment schedule.
Frequency Indicate the number of times the payment occurs during a specified time period.

For example, to set the payment frequency at twice per month:

  • Type the number 2 in the first field
  • Click the arrows in the second field and select Month from the list
Amount Enter the amount of the recurring payment.
Skip Sabbath And Holidays Select this check box to skip the Sabbath and holidays.
Send Receipt Select this checkbox to send a receipt to the customer.
Retry Declined Recurring With Default Card Only Select this check box to retry the declined recurring transaction using the default payment card.
End Click the arrow and select an option from the list.

Valid values are as follows:

  • Never
  • Date
  • Number of Payments
Number of Payments Enter the number of payments.

This field appears only if you select the Number of Payments option in the End field.

Date Click this button and select a recurring payment end date.

This field appears only if you select the Date option in the End field.

Send Payment Request Click this button to open the Send Payment Request page and send a payment request to the customer. See the Send Payment Request tab for more information.
Calendar Type Click the arrows and select a calendar type.

Valid values are as follows:

  • Gregorian
  • Hebrew

Transaction History This section contains historical transaction information.
Reference Number Displays the transaction reference number and the status of the transaction.
Amount Displays the transaction amount and whether the amount was voided or refunded.
Entered Date Displays the date and time the transaction was created.
Account Number Displays the cardholder’s account number.
Transaction Description Displays a description for the transaction.
View all customer transactions Click this link to view all transactions for this customer.
The following fields appear on all tabs.
New Transaction Click this button to open the Add new transaction dialog box.
Save Click this button to save all changes.
Delete Click this button to discard all changes.

Recurring Schedules

Watch Video

The Recurring Schedules tab enables you to easily manage your recurring payment schedules. You can use this tab to perform the following actions.

  • Add a new recurring payment schedule
  • View existing recurring payment schedules
  • Update customer recurring payment schedules
  • Export or print recurring payment schedule information
  • Update customer payment methods
  • Create a custom recurring schedule from a template
  • Create a new recurring schedule using a short form
Tips:
  • The Recurring Schedules tab opens with the recurring schedules page with today’s data displayed by default.
  • Click the Templates link at the top of the page to open the custom recurring schedule template page.
  • You can navigate between Recurring Schedules and Templates by clicking the toggle-through titles at the top left side of the page
  • Use the search fields at the top of each column to perform another search.
  • Click the arrow to the right of any column heading to sort the column.
  • Click the arrow to the left of any row to expand the row and display recurring payment schedule detail information.
  • Click between column headers to select and resize any column.
  • Hover your pointer over the information icon next to a column heading to open a tooltip message identifying the type of data displayed in the column.
  • Update ‘start date’ for future schedules. Once a schedule is running, the ‘start date’ can no longer be modified.

Note: Only a partial screen sample is displayed below. All fields are documented in the following item description table.

Recurring Schedules Tab

Complete the fields as described in the following table to manage your recurring schedules information.

Recurring Schedules Tab Item Descriptions

Item Description
Templates Click this link to open the Templates page and create a custom recurring schedule.
Filter Click this button to select one or more filter options from the list.

When you choose a filter, the system opens a text box displaying information about what filter criteria to enter.

Valid values are as follows:

  • Schedule Name
  • Company
  • Start Date
  • Frequency
  • Remaining Charges
  • Amount
  • Customer
  • Description
  • Active

Click Reset all to clear all filters or click Done to close the form and save your changes.

New Customer Click this button to open the Add a new customer schedule dialog box and create a new schedule.
Download button Click this button to export the current view or all schedules in CSV format.
Print button Click this button to open a dialog box and print a schedule.
Settings button Click this button to open a set of options to customize your page view as follows:

  1. In the Available Columns list, select the columns you want to appear on your Recurring Schedules page by default.
  2. Select the Save Selection checkbox and click Done to save the columns you selected as the default view.
  3. Alternatively, click Settings; the system opens the Report Settings subtab with the Recurring Report displayed.
  4. In the Show in Report section, select the columns you want to appear on your Recurring Schedules page and click Save; the columns you selected are saved as the default view.

The columns in this list are in the same order as the fields in the Recurring Report list on the Report Settings subtab of the Settings tab.

Note: If you click the Reset filter link, the system clears all selected options in the Available Columns list and reverts to the default column page view.

New transaction Click this button to open the Add New Transaction dialog box and add a new customer record.
Send payment request Click this button to send a payment request.

The system opens the Send Payment Request page and prefills the Payment Fields section with previously saved payment information.

Delete schedule Click this button to delete the recurring schedule.

Display Recurring Schedule Details

You can view recurring schedule details by clicking the arrow to the left of the Schedule Name to expand the view and open the customer details section on the right-hand side of the screen. Options in this section enable you to update a customer’s account profile information, payment method, recurring schedule, as well as view other transactions linked to the customer.

Tips:
  • Click another Schedule Name to display the customer details for a different customer’s recurring payment schedule without having to close the expanded view.
Recurring Schedules Details – General Settings
Recurring Schedules Details – General Settings Item Descriptions

Item Description
General This tab contains general customer information fields.
Customer # Type the customer’s unique ID number. This field is required if linking the schedule to an existing customer.

This field can never be updated.

Email Address Type the customer’s email address.
Note Free-form text field for additional customer information.
Billing Information Contains billing information fields.
First Name Type the customer’s first name.
Last Name Type the customer’s last name. Required field.
Company Type the name of the customer’s company.
Address 1 Type the first line of the customer’s address.
Address 2 Type the second line of the customer’s address.
City Type the customer’s city.
State Type the customer’s state.

For Canadian addresses, this field label displays Province.

ZIP Type the customer’s postal code.

For Canadian addresses, this field label displays Postcode.

Phone Number Type the customer’s phone number.
Mobile Phone Number Enter the customer’s mobile phone number.
Shipping Information Contains shipping information fields.
Same as billing Select this checkbox to use the same address information for shipping as billing.
Last Name Type the customer’s last name. Required field.
Company Type the name of the customer’s company.
Address 1 Type the first line of the customer’s address.
Address 2 Type the second line of the customer’s address.
City Type the customer’s city.
State Type the customer’s state.

For Canadian addresses, this field label displays Province.

ZIP Type the customer’s postal code.

For Canadian addresses, this field label displays Postcode.

Phone Number Type the customer’s phone number.
Mobile Phone Number Enter the customer’s mobile phone number.
Custom Fields Contains custom fields information.
Custom01 – Custom20 Type the name of the custom field.
Delete button Click this button to remove the custom field. This button appears only if you add a new custom field.
Add Custom Field Click this link to add a custom field.
Save Click this button to save your changes.
Close Click this button to close the tab.

Recurring Schedules Details – Payment Method Settings
Recurring Schedules Details – Payment Method Settings Item Descriptions

Item Description
Payment Method This tab contains credit card and check information.
Customer ID Displays the customer’s ID number.
Credit Card This section contains credit card fields.
Add Card Click this button to open additional card payment fields.
Set To Default Select this checkbox to set this payment method as the default payment method.
Delete button Click this button to remove the payment method.
Payment Name Type the name of the payment method.
Cardholder Name Type the cardholder’s first and last name.
Card Number* Type the 16-digit payment card number. Required field.
Exp Date* Type the payment card’s expiration date in MM/YY format. Required field.
Address* Type the CVV number.
Cardholder ZIP* Type the cardholder’s Zip code.

For Canadian addresses, this field label displays Cardholder Postcode.

Save Click this button to save your changes.
Close Click this button to close the tab.
Check This section contains check fields.
Add Check Click this button to open additional check payment fields.
Set to Default Select this checkbox to set this payment method as the default payment method.
Delete button Click this button to remove the check.
Payment Name Type an internal name you can use to identify the payment method, which is helpful if you have more than one payment method saved.

If you don’t enter a name, Cardknox uses an icon to represent the card type (Visa, Mastercard, American Express, etc.) plus four asterisks and the last four digits of the card number.

Example:

Account Name* Type the name on the account. Required field.
Routing Number* Type the account’s bank routing number. Required field.
Account Number* Type the account number. Required field.
Address* Type the CVV number.
Cardholder Zip* Type the cardholder’s Zip code.

For Canadian addresses, this field label displays Cardholder Postcode.

Save Click this button to save your changes.
Close Click this button to close the tab.

Recurring Schedules Details – Recurring Schedule Settings
Recurring Schedules Details – Recurring Schedule Settings Item Descriptions

Item Description
Recurring Schedule This tab contains recurring schedule fields.
Customer ID Displays the customer’s ID number
Add Recurring Schedule Click this button to open additional recurring payment schedule fields.
Micro menu button Click this button to open a menu of the following additional actions:

  • Deactivate Schedule – Select this option to deactivate a recurring schedule. If you choose this option, the system deactivates the schedule but does not remove it. Click Activate Schedule to reactivate the schedule.
  • Save As Template – Select this option to save the recurring schedule as a template.
  • Preview Schedule – Select this option to preview the recurring schedule details:

  • View Transactions – Select this option to see the payments that apply to this recurring schedule.


Use the icons in the upper right corner to download the list of payments to a .csv file or print to a PDF file.

Note: If more than 20 payment transactions exist, you can view them by clicking the View All Scheduled Payments button in the lower right corner.

  • Remove Schedule – Select this option to permanently delete the recurring schedule.
Schedule Name Type a name for the recurring payment schedule.
Description Type a description for the recurring payment schedule.
Amount Type the amount of the recurring payment.

You cannot update the amount for an existing schedule. If you want a different amount you must create a new recurring schedule.

Frequency Indicate the number of times the payment occurs during a specified time period.

For example, to set the payment frequency at twice per month:

  • Type the number 2 in the first field
  • Click the arrows in the second field and select Month from the list
Start Click this button and select a recurring payment start date.

The start date must be within one year of today’s date.

The default value is today’s date

Calendar Type Click the arrows and select a calendar type.

Valid values are as follows:

  • Gregorian
  • Hebrew

This field can only be changed before the schedule begins.

The default value is Gregorian.

Skip Sabbath And Holidays Select this checkbox to skip the Sabbath and holidays.
End Click the arrow and select an option from the list.

Valid values are as follows:

  • Never
  • Date
  • Number of Payments

This field can only be changed before the schedule is completed.

Send Receipt Select this checkbox to send a receipt to the customer.
Retry Declined Recurring With Default Card Only Select this check box to retry the declined recurring transaction using the default payment card.
Save Click this button to save your changes.
Close Click this button to close the tab.

Recurring Schedules Details – Transaction History
Recurring Schedule Details Item Descriptions

Item Description
Customer ID Displays the customer’s ID number.
Reference Number Displays the transaction reference number and the status of the transaction.
Amount Type the amount of the recurring payment.

You cannot update the amount for an existing schedule. If you want a different amount you must create a new recurring schedule.

Date Displays the date and time the transaction was created.
Account Number* Type the account number. Required field.
Payment Type dentifies the payment type.

Valid values are as follows:

  • Check
  • Credit Card

Transaction Type Identifies the transaction type.

Valid values are as follows:

  • Sale
  • AuthOnly
  • Capture
  • Save
Invoice Identifies the invoice number.
Transaction Description Displays a description for the transaction.
View all customer transactions Click this link to view all transactions for this customer.
Save Click this button to save your changes.
Close Click this button to close the tab.

Create a New Customer Schedule

You can quickly create a new recurring schedule by clicking the New Customer button at the top right side of the screen to open the Add a new customer schedule dialog box. The Add a new customer schedule dialog is a short form that contains only the fields necessary to create a new recurring customer schedule; the form contains an option to add additional fields as needed.

Note: Only a partial screen sample is shown below. All fields are documented in the following item description table.

Add a New Customer Schedule Dialog Box

Complete the fields as described in the following table to create a new customer schedule.

Add New Customer Schedule Dialog Box Item Descriptions

Item Description
Amount Type the amount of the recurring payment.
Frequency Indicate the number of times the payment occurs during a specified time period.

For example, to set the payment frequency at twice per month:

  • Type the number 2 in the first field
  • Click the arrows in the second field and select Month from the list
Start Date Click the calendar button and select a recurring payment start date.
Skip Sabbath Select this checkbox to skip the Sabbath and holidays.
Until Click the calendar button to select a recurring payment end date.
Credit Card Displays credit card fields.
Add Card Click this button to open additional credit card payment method fields.
Set To Default Select this checkbox to set this payment method as the default payment method.
Delete button Click this button to remove the payment method.
Card Number Type the 16-digit payment card number. Required field.
Exp Date Type the payment card’s expiration date in MM/YY format. Required field.
First Name Type the customer’s first name.
Last Name Type the customer’s last name.
Company Type the company name.
Check Displays check fields.
Add Check Click this button to open additional check payment method fields.
Set To Default Select this checkbox to set this payment method as the default payment method.
Delete button Click this button to remove the payment method.
Routing Number Type the account’s bank routing number.
Account Number Type the account number.
First Name Type the customer’s first name.
Last Name Type the customer’s last name.
Company Type the company name.
Advanced Fields Click this link to display additional payment field options.
Customer # Type the customer reference number.
Email Address Type the customer’s email address.
Note Free-form text field for additional customer information.
Billing Information Contains billing information fields.
First Name Type the customer’s first name.
Last Name Type the customer’s last name. Required field.
Company Type the name of the customer’s company.
Address 1 Type the first line of the customer’s address.
Address 2 Type the first line of the customer’s address.
CIty Type the customer’s city.
State Type the customer’s state.

For Canadian addresses, this field label displays Province.

ZIP Type the customer’s postal code.

For Canadian addresses, this field label displays Postcode.

Phone Number Type the customer’s phone number.
Shipping Information Contains shipping information fields.
Same as billing Select this checkbox to use the same address for shipping as billing.
Custom Fields Contains custom fields information.
Custom01 – Custom03 Type the name of the custom field.
Add Custom Field Click this link to add a custom field.
Cancel Click this button to clear the form and discard your changes.
Save Click this button to save all changes.

Create a Recurring Schedule Template

You can create a custom recurring schedule template using the Templates feature. When you click the Templates link at the top of the Recurring Schedules page, the system opens the Templates page. You use this page to open a dialog box and set up a new recurring schedule for an account based on the criteria you choose. Once you create the new schedule, it is saved to the Templates page where you can take further action, such as to apply the template, edit the fields, or delete the template. See New Schedule Template Dialog Box for recurring schedule setup information.

Templates

Templates Item Descriptions

Item Description
Recurring Schedules Click this link to open the Recurring Schedules page.
New schedule template Click this button to open the New schedule template dialog box.
Download button Click this button to export the current view or all schedules in CSV format.
Print button Click this button to open a dialog box and print a schedule.
Settings button Click this button to open a set of options to customize your page view as follows:

  1. In the Available Columns list, select the columns you want to appear on your custom template by default.
  2. Select the Save Selection checkbox and click Done to save the columns you selected as the default view.

Note: If you click the Reset filter link, the system clears all selected options in the Available Columns list and reverts to the default column page view.

Ellipsis button Click this button to open a menu and take action on the recurring schedule.

New Schedule Template Dialog Box

Note that any changes you make in the template do not affect any existing recurring schedules that currently use this same template.

Complete the fields as described in the following table to create a new recurring schedule.

New Schedule Template Dialog Box Item Descriptions

Item Description
Schedule Name* Type a name for the custom recurring schedule. Required field.
Amount Type a dollar amount for the recurring payment.
Frequency Indicate the number of times the payment occurs during a specified time period.

For example, to set the payment frequency at twice per month:

  • Type the number 2 in the first field
  • Click the arrows in the second field and select Month from the list
Number of Payments Type the number of payments for the recurring payment schedule.
Skip Sabbath And Holidays Select this checkbox to skip the Sabbath and holidays.
Cancel Click this button to clear the form and discard your changes.
Save Click this button to save your changes.

Send Payment Request

Watch Video

The Send Payment Request tab enables you to send a payment request link to your customers so they can access a payment site and submit their payment. You can prefill the form with customer billing and transaction information which allows your customers to enter their payment method and submit the payment quickly and conveniently without having to enter additional information. In addition, you can save time by easily modifying previously-entered information and updating the payment site link without having to reenter all information again.

Tips:
  • You can prevent a customer from changing the amount due in the Amount field on the payment form by clearing the Allow User To Adjust Amount checkbox in the Payment Fields section.

Note: Only a partial screen sample is displayed below. All fields are documented in the following item description table.

Send Payment Request

Send Payment Request Item Descriptions

Item Description
System message Click this feature to access a video that walks you through the process of completing the payment form and generating a payment site link.

Click Customer Service to send an email to Customer Service.

Send payment request using your existing PaymentSITE If you have one PaymentSITE configured in Cardknox, it’s not necessary to change this field.

If you have more than one PaymentSITE, select from the dropdown list which PaymentSITE to use to send a payment request:

You can click the Set As Default button to set the currently selected PaymentSITE as the default (the one that’s always displayed when you open the screen).

Save Click this button to create the payment site link.
Previously generated link Displays the name of the previously generated payment site link, if one exists.

Hover your cursor over the information icon to display a popup message.

Populate Fields For recurring transactions, update the appropriate Payment Fields and click this button to prefill the form with the new values.
Copy Click this button to copy the previously-generated payment site link.
Payment Fields
Billing Info This section contains billing information fields.
Amount Enter the payment amount.
Allow User To Adjust Amount Select this check box to enable the customer to change the amount due in the Amount field on the payment form.

This checkbox is selected by default. To prevent the customer from changing the amount due on the payment form, you must clear the check box.

Name Enter the customer’s name.
Company Enter the name of the customer’s company.
Address Enter the first line of the customer’s address line 1
Address 2 Enter the customer’s address line 2, if applicable.
City Enter the customer’s city.
State Enter the customer’s state.
ZIP Enter the customer’s postal code.
Country Enter the customer’s country.
Phone Enter the customer’s phone number.
Email Enter the customer’s email address.
Different Shipping Address Select this checkbox to indicate whether to use a different address for shipping.
Transaction Details This section contains transaction information fields.
Invoice Enter the invoice number.
PO Number Enter the purchase order number.
Description Enter the transaction description.
Shipping Info This section contains shipping information.
Same As Billing Select this checkbox to use the same address for billing as for shipping.
Transaction Details This section contains transaction information fields.
Description Enter the transaction description.
Recurring Schedule Fields This section contains recurring schedule fields.

Note: You must enable recurring schedules on your PaymentSITE to use these fields.

Frequency Indicates the recurring schedule payment frequency by interval type.

Type a frequency in the EVERY field then click the arrow and select an interval from the list.

Hover your cursor over the information icon to display a popup message.

Number Of Payments Indicates the number of recurring schedule payments.
Type a number of payments. The default is set to Indefinite.

Hover your cursor over the information icon to display a popup message.

Share this payment link Displays the link created based on the information you entered into the Payment Fields section.
Copy Click this button to copy the payment site link to share with your customer.
View Click this button to preview the payment site form.
Email Click this button to open an email dialog box you can use to create a message to the customer which includes a link to the payment site.

Generate Payment Link

Complete the following steps to prefill the payment form and generate a link to the payment site your customer uses to submit their payment.

  1. If you have more than one PaymentSITE form, in the Send payment request using your existing PaymentSITE section, select the form to use.
  2. Complete the appropriate billing and transaction fields for the transaction in the Payment Fields section.
  3. In the Recurring Schedule Fields section:
    1. Type a number in the EVERY field.
    2. Click the arrow and select a time period from the list.
    3. Type the number of payments in the Number of Payments field.
  4. In the Share this payment link section, you can click the View button to view the payment site. (This is optional.)
  5. To share the payment link, you can either:
      1. Click the Copy button to copy the link and paste it into an app to share with the customer (email, IM, etc.)

    OR

    1. Click the Email button to generate an email that contains the link.

Settings

Watch Video

The Settings tab contains features you use to manage your portal settings. This tab contains the following subtabs:

  • Display Settings
  • Transaction Settings
  • Recurring Settings
  • Report Settings
  • Users

Display Settings

The Display Settings subtab controls how accounts display in the account name drop-down menu.

You can perform the following actions to manage your user settings:

  • Sort fields in the account name drop-down menu alphabetically
  • Set a custom account name label to display in the account name drop-down menu
  • Drag and drop fields to customize the order in which accounts appear
  • Select a time zone
  • Select a default date range for your Dashboard
  • Select the tab you want to always display by default at login
  • Hide the Skip Sabbath and Holidays option in the Recurring Schedule subtab

Display Settings

Display Settings Item Descriptions

Item Description
Sort Alphabetically Select this checkbox to sort fields in the account name drop-down menu alphabetically.

If you want to customize the order in which the account name fields appear you must first clear this checkbox.

Accounts Identifies the name(s) in your account name drop-down menu.

Alias Type the name you want to display in the account name drop-down menu at the top right-hand side of the screen.

Drag to edit order Complete the following steps to customize the order in which accounts appear in the account name drop-down menu.

  1. Clear the Sort Alphabetically checkbox.
  2. Click the field you want to move to select it, then drag and drop it to its new location.

Timezone Click the arrow and select a time zone

Default Dashboard Date Range Click the arrow and select the default date range to display for the Dashboard.

First Screen After Login Click the arrow and select the default tab to display at login.

Hide ‘Skip Sabbath And Holidays’ Checkbox In Recurring Schedules Dialog Box Select this checkbox to hide the Skip Sabbath And Holidays checkbox for recurring schedules.
Expand New Customer Popup By Default Select this checkbox to always expand the Add a new customer dialog box by default.
Display Open Batches By Default Select this checkbox to always display the Open Batches view on the Batches tab by default.
Save Click this button to save your changes.

Transaction Settings

The Transaction Settings settings only affect the portal transaction fields. If you change the default field name, the name you set in the Custom Display Label field becomes the column name displayed in the Transaction Report subtab.

You can perform the following actions:

  • Add customized field labels
  • Select which fields are required
  • Choose whether to show or hide selected fields
  • Add custom fields
  • Set up a convenience fee
  • Set up Cardknox Go options
Tips:
  • The Custom Field To Save The Convenience Fee Amount and Custom Field To Save The original Amount fields are set by default.

The Transaction Settings subtab contains the following sections:

  • General
  • Billing Information
  • Transaction Details
  • Custom Fields
  • Other Settings
  • Set up Convenience Fee
  • Cardknox Go Settings

Transaction Settings

Transaction Settings

  1. Click Save to save your changes or click Reset to Default to discard your changes and restore the default settings.
  2. Click Expand All / Collapse All to expand or collapse all sections.

Customizing Your Field Settings

Complete the following steps to customize your field settings in each section where these options are available.

To create a customized field label:

  1. Type a name in the Custom Display Label field to change the displayed field name.
  2. Click Save.

To make a field a required entry:

  1. Select the Required checkbox to indicate a required field.
  2. Click Save.

To show or hide a field:

  1. Click the Show/Hide icon to show or hide a field.
  2. Type a name for the field and click Save.

To add a custom field:

  1. Click the Add Custom Field link to add a field. You can add up to 10 additional custom fields.
  2. Type a name for the field and click Save.

To remove a field:

  1. Click the Remove icon to remove a field.
  2. Click Save.

General
Use options in this section to set general customer account information.

Tips:
  • The name you set in the Custom Display Label field is the column name displayed in the Transaction Report subtab.

The General settings section contains the following fields.

  • Amount
  • Card Number
  • Exp Date
  • CVV
  • Email

Note: The following fields are required by default; the Required checkbox cannot be cleared and the fields cannot be hidden. You can only change the names of these fields.

  • Amount
  • Card Number
  • Exp Date

Billing Information
Use options in this section to set customer billing information.

The Billing Information section contains the following fields.

  • First Name
  • Last Name
  • Company
  • Address
  • City
  • State
  • ZIP
  • Country
  • Phone Number

Transaction Details
Use options in this section to set transaction information.

The Transaction Details section contains the following fields.

  • Invoice
  • PO Number
  • Description
  • Order Id

Custom Fields
Use options in this section to set custom information.

The Custom Fields section contains the following fields.

  • Custom01 – Custom10
  1. Click the Add Custom Field link to add a field. You can add up to 10 additional custom fields.
  2. Click the Remove button to remove a field. This button appears only if you add a custom field.
  3. Click Save.

Other Settings

Use options in this section to enable additional transaction processing actions.

Complete the steps as described in the following table.

Other Settings Item Descriptions

Item Description
Expand New Transaction Popup By Default Select this checkbox to always expand the Add new transaction dialog box.
Send The Customer A Receipt By Default Select this checkbox to always send the customer a receipt by default.
Send Me A Receipt By Default Select this checkbox to choose whether to always send yourself a receipt by default.
Allow Disabling 3DS Verification On Transactions Select this checkbox to disable 3D Secure verification.

If you choose this option, the system adds the Disable 3DS Verification checkbox to the Add New Transaction dialog box. This allows you to choose whether to bypass 3D Secure authentication if a payment declines.

See Create a New Transaction for more information about the Disable 3DS Verification option.

Allow User To Process Duplicate Transactions Select this checkbox to choose whether to always allow the customer to process duplicate transactions.

Set up Convenience Fee

Use options in this section to add an additional convenience fee to either a credit card transaction, an ACH transaction, or both.

Complete the steps as described in the following table.

Set up Convenience Fee Item Descriptions

Item Description
CC Percent Select this checkbox and type a percentage in the CC Percent field.
ACH Percent Select this checkbox and type a percentage in the ACH Percent field.
CC Set Amount Select this checkbox and type a dollar amount in the CC Amount field.
ACH Set Amount Select this checkbox and type a dollar amount in the ACH Amount field.
Custom Field To Save The Convenience Fee Amount Click the arrow and select the field you want to display the convenience fee amount on the Transactions page.

This field is set by default.

Custom Field To Save The Original Amount Click the arrow and select the field you want to display the original amount of the transaction on the Transactions page.

This field is set by default.

Allow Customer Option To Include/Exclude Conv Fee Select this checkbox to include or exclude an additional convenience fee.

Cardknox Go Settings

Cardknox Go functionality is available only to Cardknox Go merchants. Use options in this section to enable this feature.

Complete the steps as described in the following table.

Cardknox Go Settings Item Descriptions

Item Description
Show ‘Disputes” Tab Select this checkbox to display the Disputes tab in the tab menu on the left-hand side of the screen.
Include Split Pay Transactions Select this checkbox to include information about split-pay transactions on the Transactions tab.

If you choose this option, the system adds the Processing details link to the General Information section of the transaction details on the Transactions tab; you use this link to display additional processing information.

See Display Transaction Details for more information about the Processing details link.

Availability: This feature is available to Cardknox Go merchants only.

Recurring Settings

The Recurring Settings subtab contains options to manage certain recurring payment functions.

Recurring Settings Item Descriptions

Item Description
Email Recurring Daily Summary Report Select this checkbox to receive a summary of the day’s recurring transactions.
Create The Schedule Even if The Initial Payment Fails Select this checkbox to create a recurring schedule if the first payment fails.

If you choose this option, the system creates a recurring schedule even if the payment method fails.

Upon Adding A New Card, Automatically Set It As The Default Card If this box is checked, when you add a new credit card on the Payment Method tab, Cardknox sets this card as the new default payment method.
Recurring Action After X Retries This is a two-part field:

  • First, define how many times (0 – 5) you want Cardknox to retry a declined transaction.
  • Second, choose what should happen if all retry attempts fail:

    • Disable Recurring Schedule: Disable the customer’s recurring payments schedule.
    • Maintain Recurring Schedule: Keep the customer on their current recurring payments schedule.

Reset to Default Click this button to discard your changes and revert to the default settings.
Save Click this button to save your changes.

Report Settings

You use the Report Settings subtab to manage the following reports:

  • Transaction Report
  • Dispute Report
  • Customer Report
  • Recurring Report
  • Recurring Templates Report

You can perform the following actions:

  • Select default columns to display
  • Drag and drop fields to set the order in which columns appear
  • Add custom columns
  • Select the default date range

The fields that appear on any report in the Report Settings subtab depend on which fields you choose to display. You can customize these reports by choosing any of the fields currently available in the Available Columns list when you click the Settings button on the Transactions, Customers, and Recurring Schedules tabs.

Transaction Report

Note: Only a partial screen sample is displayed below.

Transaction Report

Complete the following steps to customize how your transactions display.

To set which columns to display by default:

            1. Select the Report Settings subtab and click Transaction Report.
            2. In the Show in Report section, select the columns you want to appear on your Transactions page.
            3. (Optional) To display all columns, select the Select All checkbox.
            4. Click Save; the columns you selected are saved as the default view.

To set the order in which columns appear:

            1. Click the field you want to move to select it, then drag and drop it to its new location.
            2. Click Save.

To set the default date range for the Dashboard:

            1. Click the arrow in the Default Date Range field and select a date range from the list.
            2. Click Save.

To set a default load limit:

            1. Click the arrow in the Default Load Limit field and select a number from the list.
            2. Click Save.

To show only approved transactions by default:

  1. Select the Report Should Show Approved-Only Transactions By Default checkbox.
  2. Click Save.

The fields that appear on the Transaction Report vary depending on which fields you choose to display. The following table shows an example of the fields currently available in the Available Columns list in the Settings button on the Transactions tab.

Transaction Report Item Descriptions

Item Description
Save Click this button to save your changes.
Show in Report Heading for which columns to show on the Transactions page.

The field names displayed here reflect the names you set in the Custom Display Label section of the Transaction Fields subtab.

Select All / Unselect All Select or clear this checkbox to display or unselect all columns by default, or select the checkbox next to the column label to indicate which columns to display by default.
Drag to edit order Drag and drop a field to change the order in which columns appear.
Available fields Available fields are as follows:

  • Date
  • Amount
  • Email
  • Result
  • Processing Fee
  • Company
  • Currency
  • New Sale
  • First Name
  • Last Name
  • Cardholder Name
  • Software Name
  • Card Type
  • Account #
  • ACH Status
  • Command
  • City
  • State
  • Description
  • Address
  • Zip
  • Payment Method
  • Batch
  • Invoice
  • CVV Result
  • Auth Code
  • Order ID
  • PO Number
  • AVS
  • Source Key
  • Terminal Number
  • User Name
  • IP Address
  • Entry Method
  • 3D Secure Result
  • Convenience Fee
  • Custom 1 – Custom 10

Note: You can add up to 10 custom fields.

Add Custom Field Click this link to add a custom field.
Delete button Click this button to delete the custom field.

This button only appears if you add a custom field.

Default Date Range Identifies the default date range.

Click the arrow and select a date range from the list.

Default Load Limit Identifies the number of items displayed on the page.

Click the arrow and select the number of results you want to load by default.

Reset to Default Click this button to reset all fields and filters to their default settings.
Save Click this button to save your changes.

Customer Report

The fields that appear on the Customer Report vary depending on which fields you choose to display. You can customize this report by choosing any of the fields currently available in the Available Columns list in the Settings button on the Customers tab.

Note: Only a partial screen sample is displayed below.

To add a custom column:

            1. Click the Add Custom Field link. You can add up to 10 custom fields.
            2. Click Save.

Add Custom Field

Customer Report

Customer Report Item Descriptions

Item Description
Save Click this button to save your changes.
Show in Report Heading for which columns to show on the Customers page.
Drag to edit order Drag and drop a field to change the order in which columns appear.
Reset to Default Click this button to reset all fields and filters to their default settings.
Select All / Unselect All Select or clear this checkbox to display or unselect all columns by default, or select the checkbox next to the column label to indicate which columns to display by default.
Delete button Click this button to delete the custom field.

This button only appears if you add a custom field.

Add Custom Field Click this link to add a custom field.

Recurring Report

The fields that appear on the Recurring Report vary depending on which fields you choose to display. You can customize this report by choosing any of the fields currently available in the Available Columns list in the Settings button on the Recurring Schedules tab.

Note: Only a partial screen sample is displayed below.

Recurring Report

Recurring Report Item Descriptions

Item Description
Save Click this button to save your changes.
Show in Report Heading for which columns to show in the report.
Drag to edit order Drag and drop a field to change the order in which columns appear.
Reset to Default Click this button to reset all fields and filters to their default settings.
Select All / Unselect All Select or clear this checkbox to display or unselect all columns by default, or select the checkbox next to the column label to indicate which columns to display by default.

Recurring Report Template

Recurring Report Templates

Recurring Templates Report Item Descriptions

Item Description
Save Click this button to save your changes.
Show in Report Heading for which columns to show in the report.
Drag to edit order Drag and drop a field to change the order in which columns appear.
Reset to Default Click this button to reset all fields and filters to their default settings.
Select All / Unselect All Select or clear this checkbox to display or unselect all columns by default, or select the checkbox next to the column label to indicate which columns to display by default.

Users

new

The Users subtab controls user account information. You use this module to manage the users in your database. Use this section to perform the following actions:

  • Add a user
  • Update an existing user
  • Remove a user
  • Assign and change user roles
Tips:
  • The * symbol on any screen indicates a required field.
  • Click the arrow to the right of any column heading to sort the column.

Users

Users Item Descriptions

Item Description
New User Click this button to open the Add a new user dialog box and create a new user.

See Add A New User for more information.

Download button Click this button to download all user data to a spreadsheet or .csv file.
Print button Click this button to print a report of all users.
User Identifies the user.
Role Identifies the user’s role.

User roles are as follows:

  • Admin – User has access to all permissions including users management
  • Advanced User – User has access to all permissions except for users management
  • Standard User – User can process a new transaction but cannot adjust a transaction (Void, Refund., etc.)
  • View Only – User can only access reports
  • Save Only – User can only run Save commands
  • Custom User – User has specified permissions

Note: When you select Custom User, the Permissions list is displayed. If you choose this option, you must select one or more permissions from the list.

See Add A New User for more information.

Edit button Click this button to open the Edit User dialog and update the user’s information.

Note: the Edit User dialog box contains the same fields as the Add a new user dialog box except for the email field.

See Edit A User for more information.

Delete button Click this button to remove the user.

Add A New User

Complete the following steps to add a new user.

  1. Click the New User button to open the Add a new user dialog box.
  2. Enter the user’s email address. Required field.
  3. Select a user role from the Role list.
  4. Click Create and select the Email User Invite checkbox; the system opens an email template pre-populated with the new user’s email address. Click Send to send the email.
  5. Click Cancel to clear the form and discard your changes.

Add A New User Dialog Box

Edit A User

The Edit User dialog box contains the same fields as the Add a new user dialog box except for the Email field and Email User Invite checkbox.

Complete the following steps to update an existing user.

  1. Click the Edit button to the right of the Role column to open the Edit User dialog box.
  2. Select a user role from the Role list.
  3. Click Save Changes to save your changes or click Cancel to discard your changes.

Edit User Dialog Box

User Roles

The following table describes the modules each role can access and the actions each role can perform. All roles can control their own portal settings; however, Admin is the only role that controls all settings.

User Role Descriptions

User Role Module Access Role Actions
Admin This role has access to all permissions including user management in the Settings module.

  • Dashboard
  • Transactions
  • Quick Reports
  • Gift Report
  • Batches
  • Customers
  • Recurring Schedules
  • Settings
This role can perform the following actions:

  • Create new transactions
  • Modify existing transactions
  • Generate transaction reports
  • Process the following credit card transactions:
    • Adjustment
    • Authenticate
    • AVS-only
    • Auth-only
    • Balance
    • Capture
    • Credit
    • Lookup
    • Post Auth
    • Refund
    • Sale
    • Uncapture
    • Void
  • Process the following check transactions:
    • Adjustment
    • Credit
    • Refund
    • Sale
    • Save
    • Void
  • Update account settings
  • Manage user permissions (add, delete, update permissions)

Only the Admin role can modify account settings. The Admin role cannot assign or reset passwords; for security purposes, users set their own passwords.

Advanced User This role has access to all permissions except for user management and account settings.

  • Dashboard
  • Transactions
  • Quick Reports
  • Gift Report
  • Batches
  • Customers
  • Recurring Schedules
This role can perform the following actions:

  • Create new transactions
  • Modify existing transactions
  • Generate transaction reports
  • Process the following credit card transactions:
    • Adjustment
    • Authenticate
    • AVS-only
    • Auth-only
    • Balance
    • Capture
    • Credit
    • Lookup
    • Post Auth
    • Refund
    • Sale
    • Uncapture
    • Void
  • Process the following check transactions:
    • Adjustment
    • Credit
    • Refund
    • Sale
    • Save
    • Void
  • Set their own portal preferences

The Advanced User role cannot manage user permissions, nor can they edit account settings.

Standard User This role can process a new transaction but cannot modify an existing transaction.

  • Dashboard
  • Transactions
  • Quick Reports
  • Gift Report
  • Batches
  • Customers
  • Recurring Schedules
This role can perform the following actions:

  • Create new transactions
  • Process the following credit card transactions:
    • AVS-only
    • Auth-only
    • Balance
    • Capture
    • Post Auth
    • Sale
  • Process the following check transactions:
    • Sale
    • Save
  • Generate transaction reports
  • Set their own portal preferences

The Standard User role cannot manage user permissions, edit account settings, or process voids or refunds on existing transactions.

View Only This role can only download and view reports in the following modules.

  • Transactions
  • Quick Reports
  • Gift Report
  • Customers
  • Recurring Schedules
The View Only role can perform the following actions:

  • View historical report information

This role cannot create new transactions and cannot modify existing transactions.

Save Only This role can only run save commands. This role cannot create new transactions and cannot modify existing transactions.

PaymentSITE

Watch Video

The Cardknox PaymentSITE Management module (BETA) lets you create customized payment forms. For example, on the form, you can:

  • Add custom fields
  • Change the names of field labels
  • Move fields and sections around
  • Adjust form settings to include ACH, convenience fees, terms & conditions, etc.

After you complete the form, you can request payment from customers by sending them a payment request link. The customer types in their payment details, submits the form, and you get paid.

To access the new PaymentSITE Management module, go to Settings > PaymentSITE.

Cardknox displays the PaymentSITE Management screen. Any existing forms are shown on the list:

Note: To download a list of the payment forms, click the icon.

Build the Basic Form
To start building a payment form, click either the name (under the Name column header) or the pen icon:

Cardknox opens the Payment Form Configuration screen. The default form is displayed to the right of the Manage Layout and General Settings tabs. It includes a Credit Card section with the following fields:

  • Card Number
  • Exp Date
  • CVV

Note: The initial configuration of your form may be different from what is shown here.

You can add additional sections and fields to the form. The high-level steps for creating a form are listed below. To go to each section, select a link.

  1. Add preconfigured fields and sections.
  2. Add custom sections.
  3. Add custom fields.
  4. Add optional sections from General Settings tab.

Additionally, to make minor adjustments to the form, you can:

  • Set fields as required.
  • Move fields and sections.
  • Rename sections.

After building the form, you need to:

  1. Publish it.
  2. Test it.
  3. Send the payment link to the payee.

Add Preconfigured Fields or Sections

The Configuration screen includes three preconfigured sections:

  • Billing Information
  • Shipping Information
  • Transaction Details

These sections are located on the Manage Layout tab. Click the icon to expand a section and view the available fields:

Preconfigured fields are any fields contained in the preconfigured sections. For your reference, these fields are listed below in alphabetical order:

Preconfigured Fields

Billing Information & Shipping Information Sections Transaction Details Section
  • Address
  • Address 2
  • Cell Phone
  • City/State/Zip
  • Company
  • Country
  • Email
  • First Name
  • Last Name
  • Phone
  • Number

  • Amount
  • Description
  • Invoice
  • PO Number

To add preconfigured sections and fields, follow the steps below:

    1. On the Manage Layout tab, click on a section to expand it. The Transaction Details section is shown here as an example:
    2. Click Add Entire Section to add the section (and all of its fields) to the form.

OR

  1. Click the checkbox to add individual fields to the form. When you click, Cardknox adds the field to the design area on the right.
    Repeat steps 1 and 2 for the other two sections (Billing Information and Shipping Information), if desired.

Add a Custom Section

When you first add a custom section, it is blank. After adding a custom section, you can add custom fields to it.

  1. On the Managed Layout tab, click on the New Section button and hold down the mouse button.
  2. While holding the mouse button down, drag to the right into the design area.
  3. Pause the mouse pointer over the general area where you want to place the new section. The mouse pointer indicates where you can place the new section:

    Mouse pointer is over an area that’s NOT allowed for a new section.
    The mouse pointer is over an area that IS allowed for a new section.
  4. Release the mouse button. If the new section was added correctly, you will see a “New Section.”
  • If you change your mind, you can delete the new section with the trashcan icon:
  • To move the new section up or down, use the ↑ and ↓ arrows.
  • To rename “New Section” to something else, click the pen icon and type in different text:

Add a Custom Field

When you add a custom field, Cardknox places it in a custom section. (You can click and drag it to a different location if necessary.) If you do not have a custom section in the design area,

  1. On the Managed Layout tab, click on Custom Fields to expand it:
  2. You have two options to add a field to the form design area:
    Option 1: You can click on the checkbox of a custom field to add it.
    Option 2: You can drag it:

    1. Click on the custom field and hold down the mouse button.
    2. While holding down the mouse button, drag the field onto the form design area.
    3. Pause the mouse pointer over the general area where you want to place the new field. The mouse pointer indicates where you can place the new field:

    Mouse pointer is over an area that’s NOT allowed for a new field.

    The mouse pointer is over an area that IS allowed for a new field.

Pause the mouse pointer over the general area where you want to place it and release the mouse button.

Note: Cardknox adds the custom field to the nearest section or custom section. You can drag it to a new location if necessary.

3. By default, the field you insert is a single-line text field. To change it to a different field type (multi-line text or hidden

    1. Hover over the field until you see the pop-up with icons:
    2. From the pop-up, click the desired field type.

4. To make the field required (see Note), click the star icon to the left of the field:

A field marked as required has a filled star by its name:

Note: When you set a field as required, the payee must type in the relevant information. Otherwise, it won’t be possible for them to complete the payment transactions.

5. Give the field a new name:


Include Optional (General) Settings
The General Settings tab includes optional components to include on your form:

  • ACH payment fields
  • Terms and conditions information
  • Convenience fees fields
  • Allowed command fields

To add one of these components to the form, select its checkbox on the General Settings tab. Cardknox immediately adds it to the design form. Some additional configuration may be needed in the design area to the right.

Note: To reposition these sections, go back to the Manage Layout section.

Display ACH

When you check Display ACH in General Settings, you need to define whether or not you want to require the payee to type in the Account Number and Routing Number twice. If so, check the Remove Re-Enter For ACH Account/Routing Numbers checkbox.

This is what ACH fields are included on the form:

Display Terms And Conditions

Adds a Terms and Conditions section to the form design area. After you click the Terms and Conditions checkbox, while General Settings is displayed, configure the section with the following steps:

  1. Type in a title name.
  2. Either type in or paste in the actual terms and conditions text.
  3. If you want to require the payee to select an Agree checkbox before completing the payment transaction, check Display Agree Checkbox and in Agree Label, type in the text that will appear next to it:

Display Convenience Fee

The Display Convenience Fee settings let you add convenience field fees for credit card and/or ACH transactions.

  1. Select checkboxes to define if fees are a percentage of the payment amount or a flat fee:
  2. Type in the percentage or flat amount:
  3. Link the Convenience Fee Amount and Original Amount to two custom fields:
  4. Determine if the customer can include or exclude the convenience fee.
  5. Optionally, add text to explain the convenience fee.

Allowed Commands

The Allowed Commands section lets you add up to three transaction types to the form. Select a checkbox to add it to the form:

Make Form Adjustments
This section explains how to make minor adjustments to the form, such as:

  • Setting a field as required
  • Moving a field or section
  • Renaming a section or field

Set a Field as Required

When you set a field as required, the payee must type in the relevant information. Otherwise, it won’t be possible for them to complete the payment transactions.

To define a field as required, click the star icon to the left of the field: . The star changes to red:

Note: Some fields (for example, Card Number and Exp Date for credit cards), are set to required by default and cannot be changed. A field with a red star that is disabled cannot be changed:

Move a Field or Section Up or Down
To move a field or section:

  1. Click on the field or section in the design area and hold down the mouse button.
  2. Drag the section up or down.
  3. Pause the mouse pointer over the general area where you want to place the field/section. The mouse pointer indicates where you can place it:
    Mouse pointer is over an area that’s NOT allowed.
    The mouse pointer is over an area that IS allowed.
  4. Release the mouse button.

Rename a Section

Any section in the design area that has a pen icon () next to it can be renamed. For example: PenEdit-Gray.png

  1. Click on the pen icon to open the text field for editing:
  2. Click Save to save the new name.

Delete a Section
When you delete a section, it also removes all of the fields in that section. Delete a section by clicking on its trash can icon:

A section that does not have a trash can icon is a required section and cannot be removed, such as Credit Card, ACH, Terms and Conditions, Convenience Fee.
Publish the Form
A form, once you published it, is available online, and the payee can use it to make a payment. However, before sending the payment link to the payee, we recommend first testing the form. See the next section for more information.

When you are done creating the form, click the Publish button in the upper right corner:

If you have recently changed the form, it may take a few minutes for Cardknox to display those changes.

Revert the Form
If you have published the form but want to return to the previous version, you can click the Revert button that appears next to the Publish button:

Test the Form
When you test the form, you are making sure that it’s accessible online and that it’s designed and works as you expect it to do.

To test the form:

  1. If you have been working on the form, click < Back to return to the PaymentSITE Management screen. (Otherwise, you can get to the screen by clicking Settings > PaymentSITE).
  2. For the form you want to test, click the URL in the PaymentSITE URL column.
  3. Cardknox opens the form in a new browser tab:
  4. Fill in mock data to make sure the form works as you expect it to.

Cardknox Beta Portal

You can try out new Portal features before they are released to all users. When we release a beta version of the Portal, you will be alerted in Notifications. To access the beta version, click on the link in the announcement:

Another way to access the beta version is to click on your username in the top right corner and select Enter Beta Portal:

If you change your mind and want to switch back to the previous version, click on your username in the top right corner and select Leave Beta Portal:

Test

Didn’t find what you were looking for?