Cardknox is now Sola
Learn More
LogoLogo
Contact Us
  • Introduction
  • 🔗API
    • Transaction API
      • Credit Card
      • Check (ACH)
      • EBT
      • Gift Card
      • Fraud
    • Customer and Recurring API
    • Reporting API
    • Account Boarding API
      • Account Boarding Merchant Agreement
      • Account Boarding Swagger UI
    • Code Samples
    • Error Codes
  • 📦SDK
    • .NET SDK
      • Transaction Workflow
    • iOS SDK
      • iOS SDK - Technical Guide
      • Workflow
    • Android SDK
      • Android SDK - Technical Guide
  • 🧰 Cardknox Products
    • 3D Secure 2.0
      • Client-Side Integration
        • Client-Side Integration (Non-iFields)
      • Server-Side Integration
    • Account Updater
    • Batch Processing
    • Browser-Based POS systems (BBPOS)
    • CloudIM Developer Guide
    • Deep Linking
      • Deep Linking Integration for Third-Party Websites
    • EBT Online
    • Gateway Emulators
    • iFields
      • Angular iFields
    • Merchant Portal
      • FAQ
    • Mobile App
    • Split Capture
    • Tap to Phone - Android
    • Partner Portal
    • PaymentSITE
      • QR Codes for PaymentSITE
    • Webhooks
  • 📱Mobile Wallets
    • Apple Pay Hosted Checkout
      • Apple Pay Hosted Checkout Initial Setup
      • Apple Pay Prerequisites
      • Apple Pay Hosted Checkout Objects Reference (Request)
      • Apple Pay Hosted Checkout Objects Reference (Response)
      • Apple Pay iFields Integration
      • Apple Pay Hosted Checkout Sample Code
      • Apple Pay Features
      • Set up Apple Pay Merchant ID with Cardknox
    • Click-To-Pay - Hosted Checkout
      • Click-To-Pay Initial Setup
      • Click-To-Pay Sample Code
      • Click-To-Pay iFields Integration
      • Click-To-Pay Objects Reference (Request)
      • Click-To-Pay Objects Reference (Response)
    • Google Pay Hosted Checkout
      • Google Pay Control Object
      • Google Pay Request Objects
      • Google Pay Response Objects
      • Google Pay Sample Code
      • iFields Integration
      • Google Pay FAQ
  • 🔌Plugins
    • Netsuite
      • NetSuite Features and Demo
    • WooCommerce
    • Magento Plugin
    • RMH (Retail Management Hero)
    • RMS (Retail Management Systems)
  • 📖Articles
    • Frequently Asked Questions
    • How to Build POS Integration Flows
    • Card Present Integration Guide
  • Glossary of Terms
Powered by GitBook
On this page
  • Overview
  • How to Generate Cardknox Keys
  • iFields and Transaction API
  • Cross-Origin Resource Sharing (CORS) Restrictions
  • Endpoints
  • Transaction Types
  • Questions

Was this helpful?

Export as PDF
  1. API

Transaction API

Last updated 1 month ago

Was this helpful?

Overview

The Cardknox API enables developers to process payments using the Cardknox gateway. Systems integrating with the Cardknox API can submit API calls using various commands. The API supports many payment methods, including credit cards, ACH, EBT, and gift cards.

To begin building your API integration, for a Cardknox sandbox — our secure testing environment that mimics the production environment. After signing up, you’ll be able to create user credentials for the Cardknox Merchant Portal. Once you log in to the Portal, you’ll be able to generate an API key from the Settings menu. or follow the instructions below to obtain a key.

How to Generate Cardknox Keys

  1. Sign in to the Cardknox Merchant Portal.

  2. Select "Account Settings" from the navigation bar.

  3. Select "Keys" from the sub-menu.

  4. Click "Create a Key" in the top-right corner.

  5. Choose the desired key type (API or iFields), description (software, etc.), and permissions.

  6. Click "Create and View" and copy your key.

It is critical to copy your key and save it in a secure location, as you won’t be able to obtain the key again.

iFields and Transaction API

We recommend using iFields in conjunction with the Transaction API for added security. Cardknox iFields is an iFrames solution that keeps sensitive card data away from merchant servers while granting you complete control over form layout and design. to learn more about iFields.

The Cardknox iFields solution utilizes iFrames in which the user enters their credit card and/or ACH information and then uses JavaScript to generate SUTs (single-use tokens) for processing. These features allow the website to remain secure and out-of-scope for PCI compliance while allowing the developer to customize the page layout and design fully.

Cross-Origin Resource Sharing (CORS) Restrictions

This API has Cross-Origin Resource Sharing (CORS) restrictions in place to enhance security. Requests made directly from a web browser client (e.g., JavaScript running in the browser) will be blocked.

Allowed Origins This API only accepts requests from server-side origins. Ensure that your requests originate from a server to successfully interact with the API.

Endpoints

The endpoint section defines the details for accessing and interacting with the Cardknox transaction API.

Health Check

Method: Always use GET for health checks. Protocol: Secure communication is enforced using https:// Environment: Specifies the targeted environment for the check, such as x1, x2, or b1. The primary environment is x1, with x2 and b1 available as backups.

Domain: The base URL is always cardknox.com Paths: The endpoint path for health checks is /status

Method

Protocol

Environment

Domain

Path

Example URL

GET

https

x1 (primary) x2 (backup) b1 (backup)

cardknox.com

status

https://x1.cardknox.com/status

Transactions

Method: Always use POST for transaction requests. Protocol: Secure communication is enforced using https:// Environment: The primary environment is x1, with x2 and b1 available as backups. Domain: The base URL is always cardknox.com Paths/Formats: Various paths are supported based on data format requirements:

  • /gatewayform for form data

  • /gatewayjson for JSON data

  • /gatewayxml for XML data

Method

Protocol

Environment

Domain

Path

Example URL

POST

https

x1 (primary) x2 (backup) b1 (backup)

cardknox.com

gatewayform gatewayjson gatewayxml

https://x1.cardknox.com/gatewayjson

x1 is the primary environment, with x2 and b1 as backups. The x2 and b1 environments have all resources necessary to operate independently of the other primary location.

Transaction Types

The endpoints can be found in the following child pages by navigating to the appropriate page:

Transactions

Transaction Type
Transaction (Link)
xCommand

cc:sale

cc:authonly

cc:capture

cc:adjust

cc:save

cc:avsonly

cc:postauth

cc:credit

cc:refund

cc:voidrefund

cc:voidrelease

cc:void

check:sale

check:credit

check:save

check:void

check:refund

check:voidrefund

ebtfs:sale

ebtfs:credit

ebtfs:balance

ebtfs:voucher

ebtcb:sale

ebtcb:cash

ebtcb:balance

ebtw:sale

ebtw:balance

ebtw:void

gift:issue

gift:redeem

gift:balance

gift:activate

gift:deactivate

fraud:submit

Questions

Can't find what you're looking for? Please contact .

🔗
create an account
Watch our Key Management video
Click here
Credit Card
Check (ACH)
EBT
Gift Card
Fraud
support@cardknox.com
Credit Card
Check (ACH)
Fraud
Sale
Credit
Save
Void
Refund
Check (ACH-Q)
VoidRefund
EBT Food Stamp
Sale
Credit
Balance
Voucher
EBT Cash Benefits
Sale
Cash
Balance
EBT Wic (eWic)
Sale
Balance
Void
Sale
AuthOnly
Capture
Adjust
Save
AVS Only
PostAuth
Credit
Refund
VoidRefund
VoidRelease
Void
Fraud Submit
Gift Card
Issue
Redeem
Balance
Activate
Deactivate