Merchant Portal
Overview
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:
Payment processing
Report creation
Batch and transaction history and filtering
Customer profile management
Recurring payment schedules
Email invoicing
PaymentSITE customization
Key management
User management
The Cardknox Development Team is continually adding new features and functionalities to further enhance the user experience.
This guide describes the main features of the Cardknox Merchant Portal. It contains information about features within the application with relevant screenshots, field descriptions, and procedures for managing your transactions and customer information.
Don’t yet have an account? Once you have a Merchant account set up with Cardknox, visit portal.cardknox.com/register to register for online access to the Merchant portal.
Logging In
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. You can edit which screen displays upon login in User Settings.
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 a graphical format. The previous day’s data is displayed by default. Interactive graphics give you an at-a-glance view of your company’s current financial details all on one screen to help you spot trends and monitor activity. You’ll be able to see a breakdown of transaction types, counts, and amounts. See the item description table below for more information on these features.
Item
Description
Notifications button
Click this button to display notification messages.
Item
Description
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.
Item
Description
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
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.
On the Transactions tab, you can perform the following actions:
Process a new transaction
Process a new transaction off of a previous transaction
Schedule a transaction for later processing
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.
Expanded Search Features
Certain fields include drop-down menus you can use to narrow the results of your display settings. For example, the Command field menu displays a list of commands used in transactions. Click the arrow in the column headings for the following fields to open a menu with more search options:
Command
Currency
Payment Method
Result
3D Secure Result
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
You cannot select dates in the future
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 filter criteria (such as card number or status).
Click which filter to use, and type in the criteria in the text box that is displayed:
Click the right arrow (or press the Enter key) to apply the filter right away, or you can choose more criteria from the dropdown. To see more filters, click + Advanced.
Tip: To always display the Advanced filters, select the Always Expand checkbox.
Click Reset all to clear all selected filters in the Filters list. Click Done to close the dropdown 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.
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 the gear icon to change the transactions columns that are displayed while you are logged in to Cardknox. The columns you select from here are also reflected if you download a report from this screen.
On the dropdown, under Available Columns, select the columns you want to appear on the transactions list. Click Done to save your changes.
Note: If you click Reset filter, Cardknox clears all selected options in the Available Columns list and reverts to the default column page view.
To change the columns that are always displayed on this tab:
Click Settings. Cardknox opens Report Settings with the Transaction Report displayed.
In the Fields Configuration section, under the Show in Report section, you can select the columns you want to appear on the transactions list.
Click Save. The columns you selected are saved as the default view.
Refresh Results
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.
Count
Displays the number of transactions in 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.
Display Transaction Details
You can view transaction details by clicking on a transaction row. This expands the view and opens the details section on the right-hand side of the screen.
To close the transaction details, click the X icon in the upper right corner.
In the upper right, action buttons let you print, email, download, and view a transaction receipt:
Below the transaction details, you can use the buttons to perform other actions, like void or refund the transaction:
Complete the fields as described in the following table to view transaction details or take action on the transaction.
Transaction Information
Displays the status of the transaction.
Below Transaction Information is four collapsible sections:
General Information
Billing Information
Shipping Information
Additional Information
You can expand and close the sections by clicking the * and * arrows to the left of the section name. You can also click and directly above General Information).
General Information
Displays the following information:
Amount – Amount of the transaction
Transaction Type – AuthOnly, Capture, Sale, Save
Payment Type – Credit card or check
Invoice – Invoice number
Account Number – Last 4 digits of the account number. Click the account number link to see all transactions associated with this credit card number.
Entered Date – Date and time the transaction was entered
AVS – AVS Street and AVS Zip details
Custom fields (if any)
Billing Information
Name – The payee’s first and last name.
Company – Click the company name link to see all transactions associated with this company.
Phone number –The payee’s phone number.
Shipping Information
Name, City, State, and Zip
Additional Information
Transaction details
Issuing Bank Information
Cardknox displays the issuing bank name and other information (if available).
This section displays if you have selected the Include Issuing Bank Details in Transaction Details checkbox (Account Settings > Transactions > Other Settings).
Transaction Information
Displays the status of the transaction.
Below Transaction Information is four collapsible sections:
General Information
Billing Information
Shipping Information
Additional Information
You can expand and close the sections by clicking the * and * arrows to the left of the section name. You can also click and directly above General Information).
General Information
Displays the following information:
Amount – Amount of the transaction
Authorization Amount - Amount authorized for the transaction
Transaction Type – AuthOnly, Capture, Sale, Save
Payment Type – Credit card or check
Invoice – Invoice number(s)
Account Number – Last 4 digits of the account number. Click the account number link to see all transactions associated with this credit card number.
Entered Date – Date and time the transaction was entered
AVS – AVS Street and AVS Zip details
Custom fields (if any)
Billing Information
Name – The payee’s first and last name.
Company – Click the company name link to see all transactions associated with this company.
Phone number –The payee’s phone number.
Shipping Information
Name, City, State, and Zip
Additional Information
Transaction details
Issuing Bank Information
Cardknox displays the issuing bank name and other information (if available).
This section displays if you have selected the Include Issuing Bank Details in Transaction Details checkbox (Settings > Transactions > Other Settings).
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 on an existing transaction row, 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.
Click the New Transaction button at the top right side of the screen or select the New button next to Transactions on the navigation menu: Cardknox opens the Add new transaction pop-up (shown below).
Complete the fields. For field information, see the table below.
Click the Process button.
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.
Electronic Transfer Fee
Select this checkbox to include the electronic transfer fee.
If you select the Allow Customer Option to Include/Exclude Conv Fee checkbox in the Transaction Fields section of the Settings tab, the Electronic Transfer 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 Electronic Transfer Fee checkbox does not appear and the electronic transfer fee is automatically added.
Exclude Electronic Transfer Fee
Select this checkbox to exclude the electronic transfer fee
Transaction Type
Click the arrow and select a transaction type.
Valid values are as follows:
Charge
Save
Auth Only
Refund
Post Auth
Gift: Issue
Gift: Redeem
Note: The default setting for this field is Charge. To change this default to another option, go to Settings > Transactions > Other Settings and change the Default Transaction Type field.
Card Number*
Enter the customer’s 16-digit payment card number. Required field.
Expiry 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.
The following values only appear 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*
Read the Terms & Conditions and select the I Agree checkbox to proceed. Required field.
The following values only appear when you select 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
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.
Send me a copy
Select this check box to send a copy of the transaction to the signed in user.
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 Information
This section contains the same fields as the Billing Information section.
AVS Info
Complete the following fields, if applicable:
AVS Street
AVS Zip
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.
Ignore AVS
Select this checkbox to override the AVS fraud setting defined for your Cardknox account
Process
Click this button to process the customer's payment.
Schedule Transaction
Click this button to schedule a later date to process the customer's payment. On the pop-up that displays, select the date for processing.
Note: Cardknox saves this scheduled transaction in Recurring Schedules as a one-time recurring schedule. It will not display in Transactions until after it has been processed.
Schedule a Transaction
You can schedule a transaction to run at a later date. Transactions can be scheduled for both ACH and Credit Card payments.
To schedule a transaction, navigate to the Transactions and click New Transaction.
Select the Schedule for Later icon.
Link a Customer to a Transaction
When hovering over a transaction, you will see an option for Link Payment Method.
After you click the Link Payment Method button, the system displays the Link transaction to an existing record dialog.
Use the filter fields at the top of the dialog to locate the customer record.
Click on the customer record to select it.
Click the Save button.
To view the linked transaction, open the customer record and view the Transaction History tab.
Transactions by Auth Only or Sale Only Users
Link to a New Customer — See the “Customers” section of this guide.
Link Payment Method — See the steps below.
After you click the Link Payment Method button, the system displays the Link transaction to an existing customer dialog.
Use the filter fields at the top of the dialog to locate the customer record.
Click on the customer record to select it.
Click the Save button.
Users who have Auth Only or Sale Only user permissions can create new transactions on a specific transactions screen with a limited number of fields.
To access this screen, the Auth Only or Sale Only user logs in to Cardknox and click New Transaction on the left-side navigation tab. The Transaction Type is set to Auth Only.
After filling in the required fields, save and process the transaction by clicking the Process button or pressing the Enter key.
Capture an Auth Only Sale
Once an Auth Only transaction is processed, it will appear in the Transactions tab with the Approved or Denied status. To Capture, the transaction, click the Capture icon on the right side of the Transactions screen.
A modal will appear, prompting you to confirm the amount to capture. Once finished, click the Capture button.
Process a Gift Transaction
Merchants can process gift cards in the Merchant Portal by selecting the Gift commands. This will remove the Expiration and CVV fields as gift cards do not require that information.
Merchants can process gift cards using credit card commands, however Expiration and CVV may be required (depending on the Merchant’s Portal settings). Gift cards can also be added as customers' payment methods in place of credit cards and used for recurring payments.
Gift Issue: Issues gift card, charging a credit card or ACH to issue the gift card.
Gift Redeem: Redeems a gift card, using the gift card number.
Transfers
The Transfers tab provides a quick overview of your existing transfers. This tab allows you to see the flow of money in and out of your account.
Tips:
Transfers tab management is very similar to Transactions tab.
The Transfers tab opens with the last 7 days of data displayed by default.
Use the Date Selector to choose a desired Date Range.
Use the Filter button next to Date Selector to choose your desired criteria.
Enter search criteria in the fields next to the column headings to search for a transfer.
Click the arrow to the right of any column heading to sort the column.
Click between column headers to select and resize any column.
Customize your page view by selecting the columns you want to display by default.
Use Export and Print buttons to export or print your results.
Reports
The 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(s), or amount. You can also refine your report criteria by transaction type and transaction status.
Additionally, a set of predefined reports are listed under “Quick Reports” and “Other Reports” on the far right.
Options on the Reports page enable you to do the following:
Under “Quick Reports,” generate predefined reports
Under “Other Reports,” generate an end-of-year report and expired payments report
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
Note: When selecting a date range that is greater than 90 days, expect a slower response time.
Create a Custom Report
Complete the following steps to create a custom report.
In the Create new report section, choose options from the following fields:
Select Date
View / Sort By
Transaction Type
Transaction Status
Click Add filters and select additional report options.
Click Save Report; the Custom Saved Report dialog box opens.
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.
Complete the fields as described in the following table to manage your report's information.
Hide filters
Click this link to collapse the filters list.
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
Delete button
Quick Reports
This section contains options to create reports using predefined report categories. Except for the End-of-Year report, the default date range for predefined reports is the last 30 days.
The predefined reports include:
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
End-of-year
Expired payment methods
Expired payment methods (Active Recurring)
Preview button
Download button
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:
To use the Gift Report, you must have Cardknox Gift enabled. To enable, navigate to Feature Add-Ons. Once enabled, it can be managed in Account Settings.
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 any information associated with the gift card (gift card number, name, date, location, etc.).
Activity Report
The Activity report shows today’s data by default and displays a list of all reports in your database.
Gift Activity Report
The Gift Activity tab displays all gift activity. Merchants can view all issue and redeem transactions as well as filter and search for specific transactions. Complete the fields as described in the following table to manage your gift card report information.
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 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
Type a gift card number in the search field and click Apply to display the remaining gift card balance.
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
Custom
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 tab allows Merchants with multiple locations to track summaries of funds issued and redeemed across locations. 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.
Complete the fields as described in the following table to view gift card summary information and generate a report of the totals.
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.
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
Liability report shows a list of all cards on the account as well as it’s remaining balance and activation status.
Complete the fields as described in the following table to view gift card balances and generate a report of all liabilities.
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.
Displays the customer's email address.
Count
Displays the number of items on the current page.
Remaining Balance
Displays the total remaining balance on all gift cards.
FraudWatch Report
The FraudWatch report (available to merchants who’ve signed up for the product) 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
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 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.
Click this button to open a dialog box and print a customer report.
Batches
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 the last 30 days of 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.
Complete the fields as described in the following table to manage your batch transaction information.
Menu button
Click Export to export the current view in CSV (Excel) format.
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:
Today
Yesterday
This Month
Last Month
Last 7 Days
Last 30 Days
Last 60 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
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 Totals by Card Type
You can view more batch details on the Breakdown by Card page.
Breakdown by Card
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 Button
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 total amount and transaction count for both sale and 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.
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 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.
Customers
The Customers tab displays a list of customers and enables you to easily manage your customer information.
Note that the Customers and Recurring Schedules modules are not included in the Cardknox Starter plan. If you are on the Starter plan and you attempt to access either module, you will be prompted to upgrade your account.
You can use this tab to perform the following actions.
Add a new customer record
Update customer information, payment methods, and recurring schedules
Delete customer records
View existing customer details
View customer transactions
Search for a customer
Export or print customer information
View expired or soon-to-expire payment methods
Charge and bulk charge customers
Tips:
Use the search fields at the top of each column to type in filter criteria.
Click the arrow to the right of any column heading to sort the column.
Click the arrow to the left of any row to 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.
Complete the fields as described in the following table to manage your customer information.
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.
Valid values are as follows:
Customer ID
Customer Number
Company
First Name
Last Name
Street
City
State
Zip
Phone Number
Email
Bulk Charge
Click this button to bulk charge the selected customer(s) the same amount. A number to the right of the + sign indicates how many customers you have selected.
For more information, see the Bulk Charge Customers section.
Note: This button displays only if you have selected one or more customers.
Delete
Click this button to delete the selected customer record(s). Cardknox displays a message asking you to confirm the deletion.
Note: This button displays only if you have selected one or more customers.
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:
In the Available Columns list, select the columns you want to appear on your Customers page by default.
To Search for Available Columns, enter the column name in the search bar.
Select the Save Selection checkbox and click Done to save the columns you selected as the default view.
Alternatively, click Settings; the system opens the Report Settings subtab with the Customer Report displayed.
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
View Recurring Schedule Information
Hover over the recurring schedule link to view the schedule information
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:
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.
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
Customer #
Enter a unique customer 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
Custom fields let you save miscellaneous customer data, such as comments.
Note: You cannot edit Custom01 and Custom02 fields.
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.
Bulk Charge Customers
Select multiple customers by checking the box to the left of the customer record. Tip: To select all rows, click the top-level checkbox to the left of the Filter button.
Select the icon to the right of the Filter button. A number to the right of the + sign indicates how many customers you have selected. Cardknox displays a pop-up:
Check the Send me a copy box to have a receipt emailed to your email address.
Click the Transaction Details and Customer Fields sections to expand them and fill in additional information, if necessary.
Before applying the charges, Cardknox displays a message asking you to confirm the transactions. Confirm the transactions to complete them.
Recurring Schedules
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:
Note that the Customers and Recurring Schedules modules are not included in the Cardknox Starter plan. If you are on the Starter plan and you attempt to access either module, you will be prompted to upgrade your account.
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.
Complete the fields as described in the following table to manage your recurring schedules information.
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
Recurring ID
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 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:
In the Available Columns list, select the columns you want to appear on your Customers page by default.
Select the Save Selection checkbox and click Done to save the columns you selected as the default view.
To Search for Available Columns, enter the column name in the search bar.
Alternatively, click Settings; the system opens the Report Settings subtab with the Customer Report displayed.
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.
Total Charges icon
This icon appears in the Total Charges column. If you have changed the amount of a recurring schedule that has already started, click this icon to view the updated total charges for the schedule.
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. This expands the view and opens 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.
Item
Description
General
This tab contains general customer information fields.
Customer #
Type the customer’s unique ID number. This field is required if you are 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 Schedule
Tab containing the 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. Activation/Deactivations will automatically refresh the page to display the changes. Reactivating a schedule after a missed payment will automatically charge the payment.
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:
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
By default, Cardknox populates this field with a unique schedule ID. You can type in a different schedule name; if you do this Cardknox displays the original schedule ID to the right of the name:
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.
Note: You cannot change the frequency for an existing schedule.
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
Invoice
The invoice number associated with this recurring schedule.
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.
Note: You cannot change the calendar type for an existing schedule.
Valid values are as follows:
Gregorian
Hebrew
This field can only be changed before the schedule begins.
The default value is Gregorian.
Run Recurring at a Specific Day of the Week
Click this checkbox to run monthly recurring transactions on the same weekday as the first transaction.
Example: if the first recurring payment occurs on the second Tuesday in November, all future transactions after that would also run on the second Tuesday of the month.
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.
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
When you click this link, Cardknox opens a new tab and displays 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 customer and recurring schedule by clicking the New Customer button at the top right side of the screen. This opens the Add a new customer schedule dialog box.
The Add a new customer schedule pop-up is a short form that contains only the basic fields necessary to create a new recurring customer and recurring schedule. You can access additional fields by clicking Advanced View at the bottom of the screen.
Note: To view all of the fields on the Add a new customer popup, scroll down:
Complete the fields as described in the following table to create a new customer schedule.
Note: The table below lists the fields shown in the Advanced view. If you are viewing the basic Add New Customer pop-up, you won’t see all of these fields.
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
Send Receipt
Check this box to email the customer a receipt after the transaction is completed. After you check the box, type the customer’s email in the Email address field
Item
Description
Retry declining recurring with default card only
Check this box to ensure that for declined payments, Cardknox retries the transaction using only the customer’s default credit card.
Note: For more information about recurring retries, see Settings > Recurring > Processing.
Start Date
Click the calendar button and select a recurring payment start date.
End
Select one of the options in the dropdown menu:
Never: Use this option to run the recurring payment schedule indefinitely.
Date: Use this option to stop recurring payments after a specific date. Select the date on the calendar in the Date field that appears.
Number of Payments: Use this option to indicate the number of payments included in this recurring schedule. Type the number in the Number of Payments field that appears.
Skip Sabbath and Holiday
Select this checkbox to skip the Sabbath and holidays.
Run Recurring At A Specific Day Of The Week
Click this checkbox to run monthly recurring transactions on the same weekday as the first transaction.
Example: if the first recurring payment occurs on the second Tuesday in November, all future transactions after that would also run on the second Tuesday of the month.
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.
Upload Customers and Recurring Schedules
Recurring Schedules can be created in bulk by uploading a CSV vile containing the schedule information. To upload recurring schedules, navigate to the Customers page and click the Upload Customers and Schedules link.
You'll be navigated to a page with a downloadable template file. Click the Download icon to download the template. The fields must be formatted in the same order as the template in order for the upload to be successful.
There is also a Requirements file that can be accessed, detailing the formatting requirements for the upload file.
Clicking the Requirements link will initiate a pop-up with the file requirements. All requirements can be viewed by scrolling.
The file requirements are as follows:
General Info
Billing First Name, Billing Last Name, or Company fields are required.
Payment Info
When adding a payment method, provide Payment Type as “CC” or “Check.”
If uploading credit card information, ensure the expiration date is in XXXX format.
If uploading a check, please provide a 9-digit routing number and an account number ranging from 4 to 17 digits.
If uploading ACH information, select payment type of "CC" or "Check" and include the token in the "Token" field.
Schedule Info
When uploading a schedule, you must include a payment method.
When uploading a schedule, ensure dates are in MM/DD/YYYY format. You can use “day,” “week,” “month,” or “year” in the Every field.
For multiple schedules, the first payment method added becomes the default. Use a CSV file format for your upload.
Once your file is formatted and ready to upload, click the Click to upload button under the Upload File section at the bottom of the page. Upon uploading, your data will be displayed in the portal. You can edit the data by clicking into the text boxes.
Fields that were not uploaded successfully due to improper formatting or invalid data types will trigger an error. The number of errors will be displayed, and fields will be highlighted.. If an error occurs, all of the failed rows can be downloaded as a separate file to be edited. Once ready to upload again, click the Upload Data button at the top-right of the screen.
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.
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:
In the Available Columns list, select the columns you want to appear on your custom template by default.
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.
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.
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
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 pre-fill 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 re-enter all information again.
Tip:
If your account doesn’t include the Send Payment Request feature, you’ll see information about it at the top of the screen. To add PaymentSITE to your account, click the Sign Up button.
Note: Only a partial screen sample is displayed below. All fields are documented in the following item description table.
Note: If the Copy, View, and Email buttons are disabled, this means there is no PaymentSITE associated with your account. Contact Customer Support for assistance.
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.
Item
Description
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.
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.
Note: If this is your first time using the Send Payment Request feature, first set up your email template by clicking the gear icon. For more information, see the Settings > Send Payment Request section.
Cardknox fills these fields in as described below, but you have the option to change them:
To Email: Cardknox prefills with the email entered in the Billing Information section (if one was entered).
From Email: Cardknox prefills with the Portal user email.
From Company: Cardknox prefills with the selected Company DBA in the portal account.
Click the Send Email button to send the payment request.
AVS Information
Custom PaymentSITE fields
Attach an Invoice
Recurring Payment
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.
If you have more than one PaymentSITE form, in the Send payment request using your existing PaymentSITE section, select the form to use.
Complete the appropriate billing and transaction fields for the transaction in the Payment Fields section.
In the Recurring Schedule Fields section:
Type a number in the EVERY field.
Click the arrow and select a time period from the list.
Type the number of payments in the Number of Payments field.
In the Share this payment link section, you can click the View button to view the payment site. (This is optional.)
To share the payment link, you can either:
Click the Copy button to copy the link and paste it into an app to share with the customer (email, IM, etc.)
OR
Click the Email button. Cardknox opens a pop-up with the email fields prefilled. For more information, see a description of the Email button in the “Send Payment Request Item Descriptions” table above.
Settings
The Settings tab contains features you use to manage your portal settings. This tab contains the following subtabs:
Display
Transaction
Recurring
Reports
Keys
Users
PaymentSITE
Logo
Send Payment Request
Setup MFA
Click Save to save your changes, or click Reset to Default to discard your changes and restore the default settings.
Click Expand All / Collapse All to expand or collapse all sections.
Fraud Settings
Fraud settings allows users to manage fraud parameters for transactions to control payment risk. Users can manage when they want a sale to be blocked based on multiple parameters listed below.
AVS & CVV Settings
CVV Settings
Item
Description
Block mismatch
Toggling this setting will block Card-not-present transactions if the CVV entered does not match the CVV on the card. (CVV is the three or four digit code on the back of a card)
AVS Settings
Item
Description
Decline Transaction if Street does not Match
Card-not-present transactions will decline if the full street address entered as ‘Billing Address’ does not match the address listed with the card issuer.
Decline Transaction if Zip does not Match
Card-not-present transactions will decline if the ZIP code does not match the ZIP code listed with the card issuer.
Decline Transaction if Street or Zip does not match
Card-not-present transactions will decline if either the Street or ZIP code does not match what is listed with the card issuer.
Additional ZIP codes
Listed below are additional issuer responses that can be blocked by the Cardknox merchant.
Block List Settings
Users have the option to block transaction attempts by specific data parameters listed below.
Item
Description
BIN
Block transactions by specific BIN numbers. BIN numbers are the first 6 or 8 digits of a card that identify the financial institution that issued a card. A financial institution can have multiple BIN numbers if they offer multiple card products.
Block transactions by the email address that was passed to Cardknox during the transaction.
IP & IP Range
Block transactions based on the IP address that was passed during the transaction attempt.
Block Keyed Transactions
This filter will block transactions that are keyed in at the terminal.
Block Prepaid Cards
This filter blocks all prepaid cards.
Block all cards originating outside of US & Canada
This filter will block all cards that are issued outside of US and Canada.
Transaction Screening
Enabling the Country whitelist will require the user to manually mark IP addresses country of origin for transactions. Countries not whitelisted will have transactions automatically declined if the IP does not originate from the countries whitelisted.
Allowing transactions if IP check fails or is unknown will allow transactions to succeed in the event the Cardknox gateway cannot retrieve IP information.
Additional Fraud Settings
Velocity Settings:
User Settings
User Settings controls various aspects of the platform that allows customization for specific user preferences, including date range displays, default payment types, and column settings.
General
Time zone
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.
Expand New Customer Popup By Default
Select this checkbox to always expand the Add a new customer dialog box by default.
Account Dropdown Order
Account Dropdown Order allows users to configure the order in which accounts will show when accessing the accounts a user has access to. Users can also navigate here to see which accounts they have access to, and view the account numbers. MID Numbers are displayed beside the account name.
Sort Alphabetically
Checking the box will sort available accounts in alphabetical orders
Alias
Setting an Alias will change the display name of the account in the account dropdown.
Drag to Edit Order
Re-order the accounts by selecting and holding the icon and moving the account to the preferred location.
Dashboard
Clicking Dashboard allows you to edit the Default Dashboard Date Range. Valid values are:
Today
Yesterday
Last 2 Days
Last 3 Days
Last 4 Days
Last 5 Days
Last 6 Days
Last 7 Days
New Transaction Settings
Users can set defaults for New Transactions within the New Transaction settings page. The defaults will determine what Transaction Type and Payment Type the system defaults to when the user opens a new transaction.
Transaction History
Transaction History settings determine the appearance and functionality of Transactions for users.
The Manage Columns section allows users to determine which columns appear in the Transactions Report, as well as the ordering of columns.
Use this area to change which columns are displayed for transactions. The same Manage Column functionality is also available for customers and recurring schedules settings. This affects the column display on the screen as well as exported reports.
The changes you make to the Report settings apply only to your screens and the reports that you run. They do not affect how reports display to other users on your Cardknox account.
However, there are two exceptions to this:
Recurring Templates settings affect the entire Cardknox account.
Custom reports that you create and save are available across the entire Cardknox account for other users to access.
Show, Hide, and Rearrange Columns Select or deselect a checkbox to show or hide a column. To change the column’s position on the screen (and reports), click and drag the row up or down.
Default Date Range
Sets default date range when loading historical Transactions.
Default Load Limit
Sets number of transactions to be loaded when opening the Transaction page.
Enable Reporting Across Multiple Accounts
Selecting the checkbox will enable user to generate reports that pull information from multiple accounts that they have access to.
View Authorization information on captures
Selecting the checkbox will enable authorization information to be visible on transaction detail screen.
View tokens
Selecting the checkbox will enable token to be visible on transaction detail screen.
Show Approved-Only Transactions By Default
Selecting the checkbox will display only Approved transcations when loading the Transactions page.
Show Void Status When Exported
Selecting the checkbox will include the Void Status field in the Transactions CSV export.
Batch Settings
Display Open Batches By Default
Select this checkbox to always display the Open Batches view on the Batches tab by default.
Customers Settings
Customers User Settings allows users to edit the display of information in the Customers tab. For Manage Columns section, refer to the Transaction History section above.
Expand New Customer Popup By Default
Select this checkbox to display New Customer popup as full modal when creating new customer.
Recurring Settings
Recurring Schedules User Settings allows users to edit the display of information in the Recurring Schedules tab. For Manage Columns section, refer to the Transaction History section above.
View active schedules by default
Select this checkbox to only display active schedules by default when opening Recurring Schedules
Hide 'Skip Sabbath And Holidays' Checkbox in Recurring Schedules Dialog Box
Select this checkbox to hide 'Skip Sabbath And Holidays' Checkbox in Recurring Schedules Dialog Box
Security Settings
Refer to the Setting up MFA section below.
Account Settings
New Transactions Settings
The New Transactions Settings settings only affects the transaction fields in the Merchant Portal.
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 sales tax
Set up an electronic transfer fee
Set up Cardknox Go options
Fields Configuration
In this area, you can assign different names to the fields displayed in the Transactions module. You can also:
Mark fields as required.
Hide fields that you don’t want to display.
Add custom fields.
Item
Description
Custom Display Label
Custom display label determines what appears in the customer view.
Required Checkbox
Toggling determines whether the field is required.
Visible Toggle
Processing and Receipts Settings
These Transactions Settings control some aspects of the transaction behavior in the Merchant portal.
Show Ignore AVS Option
Select this checkbox to add the Ignore AVS option to the Add New Transaction screen
Allow User to Process Duplicate Transactions
Select this checkbox to choose whether to always allow the customer to process duplicate transactions.
Expand New Transaction Popup by Default
Select this checkbox to enable the expanded new transaction screen.
Send Me A Receipt By Default
Select this checkbox to choose whether to always send yourself a receipt by default when a transaction is completed.
Send The Customer A Receipt By Default
Select this checkbox to always send the customer a receipt by default when a transaction is completed.
Enable SMS Receipts
Selecting this checkbox will allow SMS receipts to be sent to customers. $.02 SMS fee will apply for every text receipt sent. To send text receipts, Billing Cell Phone or Billing Phone Number needs to be set as a required field.
Send the Customer an SMS Receipt by Default
Selecting this checkbox will send customer SMS receipts by default for each transaction. Enable SMS Receipts must be enabled.
Electronic Transfer Fee
This section enables you to define an electronic transfer fee to apply to a credit card transaction, an ACH transaction, or both. When you enable the electronic fee feature, Cardknox automatically checks the electronic transfer fee checkbox for new transactions (see below). Cardknox also displays the electronic transfer fee amount based on what you configured in this section.
This section was previously called Convenience Fee.
Complete the steps as described in the following table.
Enable Electronic Transfer Fee
If you select this box, the Electronic Transfer Fee checkbox is automatically selected for new transactions, with the eletronic transfer fee amount displayed below the Amount field.
The ability of a customer to deselect the Electronic Transfer Fee checkbox for a transaction depends on the Allow Customer Option To Include/Exclude Electronic Transfer Fee setting below.
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 Electronic Transfer Fee Amount
Click the arrow and select the field you want to display the electronic transfer fee amount on the Transactions page.
This field is set by default.
Custom Field To Save The Original Amount
If you want customers to have the ability to deselect and select the Electronic Transfer Fee checkbox for transactions, select this checkbox.
Allow Customer Option To Include/Exclude Electronic Transfer Fee
Select this checkbox to include or exclude an additional electronic transfer fee.
Enable by Default
Select this checkbox to have Electronic Transfer Fee enabled by default when the option is present for transactions.
Apply Electronic Transfer Fee Before Sales Tax
This field is set by default. Cardknox applies the electronic transfer fee to a transaction before applying the sales tax, which means that the electronic transfer fee is taxed.
If you deselect this checkbox, Cardknox first applies sales tax and then applies the electronic transfer fee to transactions. That is, the electronic transfer fee is not taxed.
Apply to Recurring Schedules
When selected, electronic transfer fee is automatically applied to recurring schedules.
Sales Tax
This section enables you to define a sales tax to apply to transactions. When you enable sales tax, Cardknox automatically checks the Sales Tax checkbox for new transactions (see below). Cardknox also displays the sales tax amount based on the percentage you configured:
Item
Description
Enable Sales Tax
If you select this box, the Sales Tax checkbox is automatically selected for new transactions, with the sales tax amount displayed below the Amount field.
Depending on the last two settings in this section (Allow Users To…), the user may or may not be able to deselect the Sales Tax checkbox and/or change the sales tax amount.
Tax
The tax percentage to apply to transactions.
Custom Field To Save The Original Amount
By default, this field is set to Custom10.
Note: Changing this field also changes the original amount field for Electronic Transfer Fees.
Allow Users To Include/Exclude Sales Tax
If you want Cardknox users to have the ability to deselect and select the Sales Tax checkbox for transactions, select this checkbox.
Allow Users To Override Sales Tax
If you want Cardknox users to have the ability to type in a different tax amount for transactions, select this checkbox.
Add Custom Columns
For Transactions and Customers, you can display custom field data configured for your Cardknox account. (Transaction custom fields are configured in the Settings area of the portal.)
To display custom field data:
At the bottom of the list of column names, click Add Custom Field:Cardknox displays the next CustomXX field.
You may have to click Add Custom Field several times until the custom field you want is displayed:
Select the checkbox of the custom field(s) you want to display. You can also drag the custom field to a new location by clicking on it and holding down the mouse button.
Click the Save button.
Transaction History Settings
Transaction History settings provide additional flexibility and options for viewing, managing, and exporting transactions in the Transactions tab. Access the settings by clicking Transaction History.
Enhanced Amex AVS
Select this checkbox to use Enhanced American Express Address Verification Service.
Include Issuing Bank Details in Transaction Details
Selecting checkbox appends issuing bank onto the payment method.
Display Older Transactions First
Select this checkbox to reverse the default order of which transactions appear to display oldest at the top.
Printer Receipt Option
Selecting checkbox enables receipts.
Print Transactions Report In Portrait Mode
Select this checkbox for transactions to be exported in portraid mode.
Print Transactions Report On One Page
Select this checkbox to consolidate all Transactions onto one page in the PDF export (max of 15 columns).
Recurring Settings
The Recurring Settings subtab contains options to manage certain recurring payment functions. These settings apply across your entire Cardknox account and will affect all users on your Cardknox account. However, changes you make to the Enable Recurring Schedule Email Summary Report field affects only your account.
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.
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.
After X Retries With X Day(s) Between Retries…
This setting lets you configure Cardknox behaves when a transaction is declined:
First, define how many times (0 – 10) you want Cardknox to retry a declined transaction.
Second, define the number of days between retry attempts.
Third, 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.
Note: Merchants who have been with Cardknox for less than seven months have a default setting of three retries across three days. If these retries fail, Cardknox will disable the recurring schedule for that customer (payee). During the initial seven-month period, merchants cannot change this setting.
Send The Customer A Recurring Receipt By Default
Select this checkbox to always send the customer a receipt by default when a recurring transaction is completed.
Enable Recurring Schedule Summary Report
Select this checkbox to receive a summary of the day’s recurring transactions.
Send Email When Max. Number of Retries is Reached
Select this checkbox to have Cardknox send an email when the maximum number of retries (specified above) is reached.After checking this box, type in the email address(es). Separate multiple email addresses with a comma.
Send Payment Request Settings
Send Payment Request Management is used to configure the Send Payment Request email.
"Allow User To Adjust Amount" Checkbox Unchecked By Default
Checking the box will set the "Allow User to Adjust Amount" checkbox as unchecked by default in the Send Payment Request modal.
Enable Payment Requests via SMS
Checking the box enables merchant to send Payment Requests by SMS
New Customer Settings
The New Customer Settings allows users to edit the display of fields in the New Customer modal.
Custom Display Label
Sets the custom display for the field specified.
Required
Selecting the checkbox will make the field required.
Visible
Reset to Default
Resets custom displays and required fields to default values.
Cardknox Go Settings
Cardknox Go functionality is available only to Cardknox Go merchants. It can be found in the Account Settings tab by first clicking Additional Functionality. Use options in this section to enable this feature.
Complete the steps as described in the following table.
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.
Display Total Net Fee and Processing Fee in Transactions
Select this checkbox to display total net fees and processing fees in Transactions view.
Availability: This feature is available to Cardknox Go merchants only.
Users
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.
Add A New User
Complete the following steps to add a new user.
Click the New User button to open the Add a new user pop-up.
Enter the user’s email address, which is a required field.
Select a user role from the Role list. (To see all user permissions, click “+Additional roles” and scroll down.)
Click Create and Invite User button to save.
Note: To see all user permissions, scroll to the bottom of the pop-up.
Edit A User
When you edit a user, you cannot change a user’s email address, but you can change the user’s role to give them more or less system permissions. (If you need to change a user’s email address, follow the steps to add a new user instead.)
Complete the following steps to update an existing user.
For the user you want to edit, select its Edit icon (). This opens the Edit User pop-up. The Edit User pop-up contains the same fields as the Add a new user pop-up, except that the Email field is not editable.
Select a user role from the Role list. (To see all user permissions, you may need to click “+Additional roles” and scroll down.)
Click Save to save your changes.
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.
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.
Auth Only
This role can only process authorizations.
Create new authorization.
Set their own portal preferences
Sale Only
This role can process a new transaction but cannot modify an existing transaction.
New Transaction (a limited Transactions screen)
Customers
Create new transactions.
Process a credit card transaction as a sale.
Process a check transaction as a sale.
Set their own portal preferences
PaymentSITE
The Cardknox PaymentSITE Management module 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, electronic transfer fees, terms & conditions, etc.
Add your business logo
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 Download icon.
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 fields and initial configuration of your form may be different from what is shown here.
Upon loading the page, you'll see the PaymentSITE form fields on the left side of the screen, separated into header sections for Transaction Details, Shipping Information, and Billing Information. Sections can be expanded and collapsed by clicking the arrow on the right side of the section header.
You can add additional sections and fields to the form by clicking the Add a New Section button on the right side of the screen. At any point, you can click the Undo button (upper right) to undo your last step.
The high-level steps for creating a form are listed below. Instructions for performing these steps are listed below.
Add preconfigured fields and sections.
Add custom sections.
Add custom fields.
Add optional sections (including a business logo) from General Settings tab.
Additionally, to make minor adjustments to the form, you can:
Set fields as required by clicking the star icon.
Move fields and sections by holding down the cursor on the left side of the field.
Rename sections by clicking the pencil icon.
After building the form, you need to:
Publish it.
Test it.
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 Add Additional Fields plus icon to expand a section and view the available fields:
Additional fields can be added for each section, but options are limited based on which section is selected.
Preconfigured fields are any fields contained in the preconfigured sections. For your reference, these fields are listed below:
Address
Address 2
Cell Phone
City/State/Zip
Company
Country
Email
First Name
Last Name
Phone
Number
AVS Street
AVS Zip
Amount
Description
Invoice
PO Number
Display Same as Billing Checkbox
Address
Address 2
Cell Phone
City/State/Zip
Company
Country
Email
First Name
Last Name
Phone
Number
Ship City, State, Zip Required
To add preconfigured sections and fields, follow the steps below:
On the Manage Layout tab, click on Add New Fields. If pre-configured sections are not currently configured on your PaymentSITE, you'll see the option to add it. If the fields are greyed out, the section is already configured.
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.
The new section will appear in the Manage Layout tab. You can edit the title by clicking the pencil icon.
To change the placement of the section, hold down the mouse on the section and drag it up or down to place it between the appropriate sections.
If you change your mind, you can delete the new section with the trash can icon.
To rename “New Section” to something else, click the pen icon and type in different text:
Add a Custom Field
Custom Fields can be added to any section by clicking the Add Additional Fields plus icon on the section in which you wish to add the field.
The custom field will be added to the section you selected, at the bottom of the list. Custom fields that are linked in settings to a previously-defined label will include an informational icon denoting the label it is linked to. Hovering over the icon, as shown below, will display the label. Custom fields can be renamed by clicking the pencil icon.
By default, the field you insert is a single-line text field. You can change it to a different field type by hovering over the field until you see the pop-up with icons. Then, click the desired field type in the pop-up.
Single-line text
Type over “CustomXX” with a new name for the field
Multi-line text
The system automatically saves the new field name.
Hidden
A hidden field displays only to you on reports and screens in the system.
Fill in both fields:
CustomXX: Type in the field name you want to use.
Dropdown list
On the Dropdown Options pop-up, fill in both fields:
Display Label X: Type the option name to use on the dropdown list.
To add another option, click the Add Option button.
Repeat steps 1 and 2 for the items you want on the dropdown list.
Select the "Add Other Option" checkbox to include an "Other" option with text for user input
When you are done, click the Save button.
Radio button
On the Radio Options pop-up, fill in both fields:
Display Label X: Type the name of the radio button item.
To add another option, click the Add Option button.
Repeat steps 1 and 2 for each radio button item you want to display.
Select the "Add Other Option" checkbox to include an "Other" option with text for user input
When you are done, click the Save button.
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.
Configuring Amount Fields
When configuring the Amount field, the Expand button will expand the section to display Amounts and Display values.
Once expanded, rows can be moved up or down by selecting the up or down arrows. To collapse the selection, click the same button used to expand.
Clicking Add Additional Option will add another row for them to set the reporting/display values. Toggling the Add Other Option toggle will add a row with the reporting value set to "Other", as an uneditable field, and the display value will be pre-filled to ‘other’ with the option to edit.
Reordering Sections
To reorder sections in the Manage Layout tab, simply click and hold the section header (i.e. Transaction Details) and drag the section to the desired area. Sections can be reordered while collapsed or expanded.
Credit Card and ACH Settings
The Credit Card and ACH Settings are on the right side of the Manage Layout screen. Selecting the star icon will toggle the fields required. Some fields, such as card number for credit card or account number for ACH, cannot be toggled off of required.
General Settings
The General Settings tab includes optional components to include on your form:
Terms and conditions information
Electronic transfer fees fields
Allowed transaction types
Business logo
ACH payment fields
Add Additional Account Tabs
Add Redirect Options
Allowed Transaction Types
Display ACH
Display Card Types Accepted
Display Electronic Transfer Fee
Display PaymentSITE Logo
Display Terms and Conditions
Enable Digital Wallet
Receipt Options
Add Additional Account Tabs
Add Redirect Options
Allowed Transaction Types
Display ACH
Display Card Types Accepted
Display Convenience Fee
Display PaymentSITE Logo
Display Terms and Conditions
Enable Digital Wallet
Receipt Options
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.
Add Additional Account Tabs
The Add Additional Account Tab options allows you to add additional, custom tabs on the form (these can be adjusted on the Manage Layout page and the General Settings page).
These tags have a title and a body that can be used however you like!
Add Redirect Options
The Add Redirect Options tab allows you to enable/disable redirects in the form, as well as configure those redirects.
Allowed Transaction Types
The Allowed Transaction Types section lets you add up to three transaction types to the form. Select a checkbox to add it to the form:
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.
The following ACH fields are included on the form:
Display Card Types Accepted
The Display Card Types Accepted setting lets you specify which types of credit cards are allowed for the given form. The available options are:
Visa
Mastercard
Discover
Amex
Checking the box next to the setting enables it, and once enabled you can enable or disable the types of cards allowed. All cards are enabled by default.
Display Electronic Transfer Fee
The Display Electronic Transfer Fee settings lets you add electronic transfer fee fields for credit card and/or ACH transactions. Please Note: Electronic transfer fees cannot be enabled if Service Fee has been enabled in the Internal Settings section.
Select checkboxes to define if fees are a percentage of the payment amount or a flat fee.
Type in the percentage or flat amount.
Link the Electronic Transfer Fee Amount and Original Amount to two custom fields.
Determine if the customer can include or exclude the electronic transfer fee.
Optionally, add text to explain the electronic transfer fee.
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:
Type in a title name.
Either type in or paste in the actual terms and conditions text.
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:
Enable Digital Wallet
Enabling Digital Wallet for your PaymentSITE allows you to support additional payment options (such as Apple Pay, Google Pay and Click To Pay) for your customers. When Enable Apple Pay, Google Pay or Click To Pay is checked, your PaymentSITE will include the corresponding button like Apple Pay, Google Pay and/or Click To Pay Button(s).
Receipt Options
The Receipt Options setting allows you to enable or disable the following:
Whether to send the customer a receipt
Show pop-up instead of receipt for approved cc:sale transactions
Set the default receipt to a printed receipt
Show or hide the logo on a printed receipt
Themes
This section allows you to select the theme of the PaymentSITE form, as well as setting a background color:
Make Form Adjustments This section explains how to make minor adjustments to the form, such as:
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:
Type in a title name.
Either type in or paste in the actual terms and conditions text.
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:
Enable Digital Wallet
Enabling Digital Wallet for your Payment Site allows you to support additional payment options (such as Google Pay) for your customers out of the box. When Enable Google Pay or Enable Apple Pay is checked your Payment Site will include options for the digital wallets.
Receipt Options
The Receipt Options setting allows you to enable or disable the following:
Whether to send the customer a receipt
Show pop-up instead of receipt for approved cc:sale transactions
Set the default receipt to a printed receipt
Show or hide the logo on a printed receipt
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
Move a Field or Section Up or Down To move a field or section:
Click on the field or section in the design area and hold down the mouse button.
Drag the section up or down.
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.
Release the mouse button.
Rename a Section
Any section in the design area that has a pen icon next to it can be renamed.
Click Save to save the new name.
Click on the pen icon to open the text field for editing:
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.
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.
Publish the PaymentSITE 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.
Publish the PaymentSITE Once you publish your changes, the PaymentSITE is available online and the payee can use it to make a payment. However, before sending the payment request to the payee, we recommend first testing it. See the next section for more information.
When you are done creating the payment request, 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.
Undo the Form If you have published the form but want to return to the previous version, you can click the Undo 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:
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).
For the form you want to test, click the URL in the PaymentSITE URL column.
Cardknox opens the form in a new browser tab:
Fill in mock data to make sure the form works as you expect it to.
PaymentSITE Kiosk Configuration
The PaymentSITE Kiosk can be configured by navigating to PaymentSITE in Account Settings and clicking Kiosk in the menu.
The Kiosk configuration mirrors the PaymentSITE configuration, with Manage Layout and General Settings tabs.
Manage Kiosk Layout
The Kiosk layout configuration includes the same functionality as the general PaymentSITE configuration. More information can be found in the PaymentSITE section above.
Kiosk General Settings
The Kiosk General Settings match the PaymentSITE settings, with more detail found here. Only settings related to the Kiosk will be found within the Kiosk settings.
Logo Management
In this section, you can upload your company logo, which will be displayed on your customer email receipts. You can also choose to display your logo on your portal print receipts, Send Payment Request emails, and on your Portal webpage account.
Any changes you make in this section will affect all users on your Cardknox account.
Item
Description
Choose File
Click this button to open a popup where you can select the image file to upload. By default, the logo displays on customer receipt emails.
Include my logo on my merchant portal account
Select this checkbox to also display the logo at the bottom of the navigation menu.
Include my logo on portal print receipts
Select this checkbox to also display the logo on printed portal receipts.
Include my logo on Send Payment Request emails
Select this checkbox to also display the logo on Send Payment Request emails.
Upload a Logo Image File Before you upload an image file, make sure it conforms to these specifications:
Maximum image width is 360 pixels.
Formatted as .png, .jpg, or .jpeg.
Go to Settings -> Logo.
Click the Choose File button.
On the pop-up, locate and select the image file you want to upload. Cardknox uploads the image and shows a preview of it:
To display the logo in other areas of Cardknox besides the customer email receipt, select the appropriate checkboxes.
Click the Save button.
Remove a Logo Image File
Go to Settings -> Logo.
Below the logo preview, click the Remove logo button.
Click the Save button.
Payment Methods
In this section you can set up your account to accept Apple Pay.
Just click on “Register your Domain” button and follow 3 easy steps:
Key Management
The Key Management module enables Admins to add security by controlling API access. There are two methods you can use to configure API security:
Creating keys for API calls and iFields – Create API keys and assign them a permission level to control what type of API calls it can make. You can also define the IP addresses that can use the key.
Whitelisting IP addresses – Define which IP addresses can make API calls for your Cardknox account.
Whitelist IPs
To whitelist IP addresses for your entire account, click the Create Key button and enter the IP addresses in the drop-down to whitelist. Cardknox opens a pop-up:
Type the IP address(es) into the text box. To enter multiple IPs, type each one on a separate line. Click the Apply button to save your changes.
These are the IP addresses that have permission to use your API keys. Only computers that have these IP addresses will have permission to make API calls with the API keys.
Any other IP addresses will be denied access to the Cardknox API. Note that when you whitelist IP addresses here, it overrides any IP addresses that are whitelisted at the key level.
Create Key
Click the Create a Key button to open the Create a Key pop-up. See the “Add a Key” section below.
Key Description (Column)
This column displays the key description you defined when you created the key.
Key Description (Filter field)
To search for a key, begin typing its description in this field. Cardknox refreshes the list to display the relevant results.
Key Type (Column)
This column displays the key type you chose when you created the key.
Key Type (Filter field)
To search for a key by its type, type either “API” or “iFields” in this field. Cardknox refreshes the list to display the relevant results.
Edit
Click this button to open the Edit a Key pop-up for the associated key. See the “Edit a Key” section below.
Copy
Click this button to create a copy of the associated key, which you can then edit. See the “Copy a Key” section.
Delete
Click this button to delete the associated key. Use this command with caution; if any software is using the key, it will no longer work. See the “Delete a Key” section below.
Add a Key
Click the Create a Key button.
On the pop-up, define the following fields: Keys Field Pop Up
Click the Create and View button to save.
Edit a Key
Note that editing a key does not change the assembly of characters and numbers that make up the unique key. Instead, you can change the key’s description, permissions, and allowed IP addresses.
For the key you want to edit, select its Edit icon . This opens the Edit a Key pop-up.
Edit a KeyThe Edit a Key pop-up contains the same fields as the Create a Key pop-up, except that the Type field is not editable.
Make changes to the key’s description, permission, or allowed IPs. For more information, see the field descriptions in the “Add a Key” section.
Click the Save Changes button.
Copy a Key
When you copy a key, Cardknox duplicates the key in every way, except it generates a different key (i.e., the unique assembly of text and numbers). Since the copy steps are very similar to creating a key, use the “Add a Key” steps as a reference.
For the key you want to copy, click its Duplicate icon. Cardknox opens the Create a Key pop-up with the fields prefilled based on the key you used.
Change the Description field so that it is unique.
If necessary, make changes to the key permission or allowed IPs.
Click the Create and View button to save.
Delete a Key
Before you delete a key, make certain that none of your organization’s software is using the key to access Cardknox.
For the key you want to delete, click its Delete icon. Cardknox displays a warning message, asking you to confirm the deletion.
Click Yes to confirm the deletion.
Send Payment Request
Use this section to change the email text that gets sent to a customer with the Send Payment Request feature. You can also change the default setting of the checkbox that allows the payee to adjust the amount due.
Send Payment Request Email
You can add, remove, or change the text that displays in the email’s Subject line or in the body of the email.
Tip:Reset button.
You can insert placeholders for variable information such as invoice number, name, etc. Cardknox automatically fills in the appropriate information when sending the email.
The available placeholders are:
[company] – Inserts your company’s business name.
[invoice] – Inserts the invoice number associated with the request for payment.
[name] – Inserts the customer’s name.
[link] – Inserts the PaymentSITE website address that is specific to this customer’s payment request.
Before saving your changes, you can send a test email:
Click the Send Test Email button. Cardknox displays a pop-up.
Type your email address in the To email field.
Optionally, you can change the From email and From company fields.
Click the Send Email button to send the test email.
Allow User To Adjust Amount Checkbox Unchecked By Default
This checkbox controls the default setting for the Allow User To Adjust Amount checkbox that is displayed on the Send Payment Request screen:
If this box is selected, the Allow User To Adjust Amount checkbox is unchecked by default.
If this box is not selected, the Allow User To Adjust Amount checkbox is checked by default.
Setup MFA
With Multi-Factor-Authentication (MFA), you can feel more secure about your Merchant Portal account. MFA adds another layer of security beyond the standard login with a password.
Once you enable MFA for your account, if the system detects a login problem, the user must type in a code to complete the login process.
To use MFA for your Merchant Portal account:
You (as the Cardknox administrator) need to install an MFA app. (Some examples are Authy, Google Authenticator, and LastPass Authenticator.)
Turn on MFA (Settings > Setup MFA) and perform a one-time configuration step.
Instruct other Merchant Portal users to install an MFA app.
How MFA Works When Logging In
While logging in, the user types in an incorrect password.
If Cardknox detects a suspicious login, it displays a message asking the user to type in the code currently shown on their MFA app (Authenticator.cc, Authy, Google Authenticator, etc.).
The user types in the code and clicks Confirm Sign-in, and the system logs the user in.
Reset Password
Resetting your password is easy in the Customer Portal - just hit the “Reset Password” button and Cardknox will send the email associated with your account an email with a verification code.
Enter the code we send you and your new password and hit the “Save new Password” button
You will get a confirmation popup when the process is complete.
Cardknox Beta Portal
Reset Password
Resetting your password is easy in the Customer Portal - just hit the “Reset Password” button and Cardknox will send the email associated with your account an email with a verification code.
Enter the code we send you and your new password and hit the “Save new Password” button
You will get a confirmation popup when the process is complete.
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 “Enter Beta Portal” to the right of your username.
If you change your mind and want to switch back to the previous version, click on “Leave Beta Portal” to the right of your username.
Last updated
Was this helpful?
