Magento Plugin
Last updated
Was this helpful?
Last updated
Was this helpful?
The Magento Cardknox plugin will allow you to charge credit cards via the Cardknox gateway. Cardknox enables credit card payments for both customers on the storefront and for merchants in the Admin portal. The plugin supports Authorize Only, Capture, Void, Cancel, and Refund transactions. As a merchant, your web servers remain out of scope of the transaction, keeping card data secure and simplifying PCI compliance.
Install the plugin from .
To install the Cardknox plugin:
Unzip the folder to app/code/CardknoxDevelopment/Cardknox (create the directories if needed)
Run the below commands in the Magento root directory (bash).
Enable the module
Optionally flush the cache
Navigate to Stores > Configuration > Payment Methods > Cardknox which will bring you to the configuration page (see below).
Item
Description
Enabled
This enables the Cardknox Module. Set to ‘Yes’ to enable Cardknox payments.
Title
Name of payment method. This will appear to users when selecting a payment method. We recommend selecting ‘Credit Card.’
Vault Enabled
This enables the customer to save cards for later use on the site.
Vault Title
Name of vault payment method. This will appear to users when selecting a card on file. We recommend selecting ‘Stored Cards.’
Cardknox Transaction Key
Your Cardknox API transaction Key.
Cardknox Token Key
Your Cardknox token key (iFields key).
Debug
Logs transaction data for troubleshooting purposes.
Payment Action
Sets the transaction payment mode. If ‘Authorize’ is selected, all transactions will need to be captured when invoicing an order.
Enable Split Capture For Credit Card
Payment from Applicable Countries
Select ‘Specific Countries’ to only allow payment from the ‘Payment From Specific Countries’ whitelist.
Payment from Specific Countries
Select countries you wish to whitelist.
Cardknox Gateway Endpoint
Cardknox URL to which transactions are routed (this setting should not be modified unless advised to do so by Cardknox Support).
Google reCAPTCHA V2 Enable
This enables Google reCAPTCHA V2
Google API Key V2
Your Google reCaptcha Site Key V2
Google API Secret Key V2
Your Google reCaptcha Secret key V2
Sort Order
Priority of Cardknox in list of payment methods.
Item
Description
Item
Description
Enabled
Title
Name of payment method. This will appear to users when selecting a payment method. We recommend selecting ‘Google Pay’
Merchant Name
Enter the merchant name (DBA)
Environment
GooglePay Payment Action
Sets the transaction payment mode. If ‘Authorize’ is selected, all transactions will need to be captured when invoicing an order.
Enable Split Capture For GooglePay
Button Style
This sets the Google Pay button style
Payment from Applicable Countries
Select ‘Specific Countries’ to only allow payment from the ‘Payment From Specific Countries’ whitelist.
Payment from Specific Countries
Select countries you wish to whitelist.
Sort Order
Priority of Google Pay in list of payment methods.
Item
Description
Item
Description
Enabled
Title
Name of payment method. This will appear to users when selecting a payment method. We recommend selecting ‘Apple Pay’
Merchant Identifier
The default value is merchant.cardknox.com
Environment
Sets the Apple Pay environment.
Apple Pay Buton Style
This sets the Apple Pay button style
Apple Pay Buton Style
This sets the Apple Pay button style
Payment Action
Sets the transaction payment mode. If ‘Authorize’ is selected, all transactions will need to be captured when invoicing an order.
Payment from Applicable Countries
Select ‘Specific Countries’ to only allow payment from the ‘Payment From Specific Countries’ whitelist.
Payment from Specific Countries
Select countries you wish to whitelist.
Sort Order
Priority of Apple Pay in list of payment methods
Select Credit Card as the payment method in the Payment & Shipping Information section (see Title in the Configuration Options section of this document).
If ‘Authorize’ is selected as the Payment Action in the Cardknox module settings (see Payment Actions in the Configuration Options section of this page), select ‘Capture Online’ to capture the transaction before submitting the invoice. Please note that previously voided transactions cannot be captured and will result in an error.
Use ‘Void’ to cancel transactions on orders that have not yet been invoiced. This is only available if ‘Authorize’ is selected as the Payment Action in the Cardknox module settings (see Payment Actions in the Configuration Options section of this document). Once an order has been invoiced, use ‘Credit Memo’ to refund the transaction.
Please note that ‘Void’ cancels the credit card transaction but does not cancel the order. To cancel the order as well, see the Cancel section below.
Use Cancel to void an un-captured transaction and cancel the associated order.
Issue a Credit Memo to refund an order that has already been invoiced.
Cardknox transaction reference numbers can be found in the Transaction History section of any order page and are listed as Transaction ID. This can be useful when viewing your transactions on the Cardknox Gateway portal or when contacting Cardknox Support regarding specific transactions.
When Payment action is set to Authorize, this will allow you to when capturing (invoicing) a transaction.
This enables Cardknox Google Pay . Set to ‘Yes’ to enable Google Pay. Please ensure that your Cardknox account is configured for Google Pay. Please contact to confirm
Sets the Google Pay environment. This must match the environment set on the Cardknox account. Please contact to confirm
When Payment action is set to Authorize, this will allow you to when capturing (invoicing) a transaction.
Please complete the Apple Pay Domain Registration prior to enabling Cardknox Apple Pay
This enables Cardknox Apple Pay . Set to ‘Yes’ to enable Apple Pay. Please ensure that your Cardknox account is configured for Apple Pay. Please contact to confirm