API INTRODUCTION

Overview

The Cardknox API enables developers to process transactions via the Cardknox gateway. The API uses simple commands to make integrating with Cardknox a seamless experience.

Cardknox uses the same url for both sandbox and live accounts and they are differentiated only by the authentication key that is used. Cardknox calls this xKey. Request a sandbox account.

The API supports Credit Card, Check (ACH), EBT, Gift Card and Fraud Protection transactions. A web-based portal is available to search transactions, run reports, as well as other account features.

Cardknox also offers emulators for many popular gateways. Emulation enables developers to simply change the endpoint URL for systems currently integrated with 3rd-party gateways and use the existing commands supplied by those gateways, without the need for additional programming. Request an emulation account.

iFields

Cardknox’s iFields offers a secure solution for the client-side application, which significantly simplifies the PCI burden. It does so by hosting the sensitive payment fields (via iframes) so the cardholders’ sensitive payment information goes directly to our PCI DSS validated servers, while allowing you to retain full control of the look and feel of the payment flow. Using our iFields solution in conjunction with our API will allow you full flexibility while staying out of PCI scope. Click here to learn more about iFields.

Credentials

When you sign up for a Cardknox account, you will receive a sandbox xKey which is used to identify your account and enable you to perform test transactions. A separate xKey will be sent for your live account.

When sending a transaction, your Cardknox credentials xKey, name of your software xSoftwareName, version of your software xSoftwareVersion and Cardknox API version xVersion is required on each request.

Note

All sample code is populated with the latest API version by default, which is currently 4.5.8. This API version should be used unless directed otherwise by Cardknox.

Endpoints

Below are the endpoints URLs to send transactions to Cardknox:
URL: https://x1.cardknox.com/gateway
Alternate URL: https://b1.cardknox.com/gateway

We now support both JSON and XML via the following URLs:
JSON: https://x1.cardknox.com/gatewayjson
XML: https://x1.cardknox.com/gatewayxml

Request Method

Method:POST
Cardknox Gateway requires POST method to be used for enhanced security. We do not support the GET method.

Tokenization

Tokenization is the process of replacing sensitive payment data with a non-sensitive algorithm-generated string called a token. Each time a card or bank account number is sent with a transaction, the Cardknox response will include a token represented by xToken. As a merchant’s PCI-compliance scope is greatly increased when storing sensitive data, best-practice is to store the token in your database instead of the sensitive data and use the token for follow-up transactions. With this approach, if a data breach occurs on your local system, sensitive data will not be at risk.

When a token is sent along with a transaction, Cardknox references the payment information on our servers associated with that token, and processes the transaction. Each time a transaction is processed, a new token will be returned.

A token only stores the data sent with a transaction that is necessary to process future transactions. It does not store general customer information such as billing and contact information.
As an example, for a credit card transaction, only the credit card number, expiration date, street address and zip code (which can be required for Address Verification System (AVS) validation) are stored with token.

Note: The 3 or 4 digit CVV number is never stored on Cardknox servers as per PCI regulations, and in extension, is not associated with tokens. CVV data is only used when processing initial transactions where the cardholder is generating the transaction with their physical card in hand.

To generate a token for a payment method without processing a transaction, use the save command. For credit card transaction cc:save. For check transactions, check:save.
The documentation below indicates which transaction types support tokenization.

Batches

Each day, all captured transactions are added to a batch file. Once the batch cutoff time is reached (determined by the processing bank), Cardknox automatically “batches out”, which sends the related transactions to the bank for settlement. A batch report is available in the Cardknox portal.

Response Parameters

Transactions that are submitted to the Cardknox API will return a response with one or more of the fields below. Below are the standard parameters and their values.

Field Name	Description	Values
xResult	Transaction status	A E D
xStatus	Result verbiage	Approved Error Declined
xError	Error message, if applicable	See error code
xErrorCode	Error code	Most common error codes; 00000 = Approved 01332 = Duplicate Transaction 1334 = Declined Transaction 01479 = Invalid Card
xRefNum	Cardknox transaction Reference Number Note: xRefnum is always returned regardless of the outcome of the transaction.
xInvoice	Invoice number
xExp	The card expiration number
xAuthCode	Authorization code, approved transactions only
xBatch	Batch into which transaction will settle
xAvsResultCode	The Address Verification Service (AVS) response code	YYY = Address: Match & 5 Digit Zip: Match NYZ = Address: No Match & 5 Digit Zip: Match YNA = Address: Match & 5 Digit Zip: No Match NNN = Address: No Match & 5 Digit Zip: No Match XXU = Address Information not verified for domestic transaction YYX = Address: Match & 9 Digit Zip: Match NYW = Address: No Match & 9 Digit Zip: Match XXR = Retry / System Unavailable XXS = Service Not Supported
xAvsResult	AVS verbiage	See AVS result code
xCvvResultCode	Card Code Verification (CCV) response code	M = Match N = No Match
xCvvResult	CVV verbiage	See CVV result code
xAuthAmount	The total amount authorized, inclusive of tax and tip (if applicable).
xMaskedCardNumber	A masked version of the credit card used for the transaction
xCardType	Type of credit card used for the transaction	Unknown EBT GiftCard Amex Visa MasterCard Discover Diners JCB
xName	Name of card holder
xToken	Token returned for use with future transaction.
xEntryMethod	Transaction Method	Keyed EMV Swipe
xRefnumCurrent	Current Reference Number	Used for troubleshooting purposes only. Returned when using a command that modifies an existing transaction such as cc:void, cc:capture, or cc:adjust.

Sample Code Generator

The sample code generator allows you to dynamically build sample code. Select your preferred language & transaction type and choose from the optional variables. The sample code will update based on your selections. If you enter your Cardknox credentials, you can also run the sample code and receive live response variables. Each command has a “Generate Sample Code” button so that you can conveniently generate sample code from any command in the documentation below.

Note

A Sandbox or Live xKey is required to run sample code. Request a sandbox account.

Credentials

Set Credentials

Language

Transaction Type

Variables

SAMPLE PHP CODE

Only Show Variables

<?php

// Request

$data = array();

$data["xKey"] = ""; //Credential

$data["xVersion"] = "";

$data["xSoftwareName"] = ""; //Name of your software

$data["xSoftwareVersion"] = ""; //Version of your software

$data["xCommand"] = "";

$data["xCardNum"] = "";

$data["xExp"] = "";

$data["xName"] = "";

$data["xAmount"] = "";

$data["xAccount"] = "";

$data["xMagstripe"] = "";

$data["xToken"] = "";

$data["xCustom01"] = "";

$data["xCVV"] = "";

$data["xStreet"] = "";

$data["xZip"] = "";

$data["xBillFirstName"] = "";

$data["xBillMiddleName"] = "";

$data["xBillLastName"] = "";

$data["xBillCompany"] = "";

$data["xBillStreet"] = "";

$data["xBillStreet2"] = "";

$data["xBillState"] = "";

$data["xBillCity"] = "";

$data["xBillZip"] = "";

$data["xBillCountry"] = "";

$data["xBillPhone"] = "";

$data["xBillMobile"] = "";

$data["xShipFirstName"] = "";

$data["xShipMiddleName"] = "";

$data["xShipLastName"] = "";

$data["xShipCompany"] = "";

$data["xShipStreet"] = "";

$data["xShipStreet2"] = "";

$data["xShipCity"] = "";

$data["xShipState"] = "";

$data["xShipZip"] = "";

$data["xShipCountry"] = "";

$data["xShipPhone"] = "";

$data["xShipMobile"] = "";

$data["xRefNum"] = "";

$data["xAuthCode"] = "";

$data["xIP"] = "";

$data["xRouting"] = "";

$data["xCardpresent"] = "";

$data["xDUKPT"] = "";

$data["xTax"] = "";

$data["xTip"] = "";

$data["xInvoice"] = "";

$data["xPONum"] = "";

$data["xComments"] = "";

$data["xDescription"] = "";

$data["xEmail"] = "";

$data["xFax"] = "";

$data["xBillState"] = "";

$data["xAllowPartialAuth"] = "";

$data["xRxAmount"] = "";

$data["xDentalAmount"] = "";

$data["xVisionAmount"] = "";

$data["xTransitAmount"] = "";

$data["xCopayAmount"] = "";

$data["xClinicalAmount"] = "";

$data["xOrderID"] = "";

$data["xExistingCustomer"] = "";

$data["xAllowDuplicate"] = "";

$data["xMICR"] = "";

$data["xCheckNum"] = "";

$data["xCheckImageFront"] = "";

$data["xCheckImageBack"] = "";

$data["xVoucherApproval"] = "";

$data["xVoucherSerial"] = "";

$data["xGatewayRefNum"] = "";

$data["xGatewayResult"] = "";

$data["xGatewayError"] = "";

$data["xGatewayCVV"] = "";

$data["xGatewayAVS"] = "";

$data["xOrderItems"] = "";

$data["xOrderType"] = "";

$data["xCustomerComments"] = "";

$data["xShipMethod"] = "";

$data["xShipAmount"] = "";

function buildQuery($data)

{

if(function_exists('http_build_query') && ini_get('arg_separator.output')=='&') return http_build_query($data);

$tmp = array();

foreach($data as $key=>$val) $tmp[] = rawurlencode($key) . '=' . rawurlencode($val);

return implode('&', $tmp);

}

$data = buildQuery($data);

$ch = curl_init("https://x1.cardknox.com/gateway");

if(!is_resource($ch))

{

echo "Error: Unable to initialize CURL ($ch)";

exit;

}

curl_setopt($ch, CURLOPT_HEADER, 1);

curl_setopt($ch, CURLOPT_POST,1);

curl_setopt($ch, CURLOPT_TIMEOUT, 45);

curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

$raw_result = curl_exec($ch);

if(curl_error($ch) != "")

{

echo curl_error($ch);

}

elseif(!strlen($raw_result))

{

echo "Error reading from card processing gateway. Please contact the merchant to verify whether transaction has been processed.";

curl_close($ch);

exit;

}

elseif($raw_result == false)

{

echo "Blank response from card processing gateway.";

curl_close($ch);

exit;

}

else

{

// SUCCESS

curl_close($ch);

// result will be on the last line of the return

$tmp = explode("\n",$raw_result);

$result_string = $tmp[count($tmp)-1];

parse_str($result_string, $result_array);

print_r($result_array);

}

SAMPLE Java/Android CODE

Only Show Variables

public void postData()

{

//Create a new HttpClient and Post Header Java/Android

HttpClient httpclient = new DefaultHttpClient();

HttpPost httppost = new HttpPost("https://x1.cardknox.com/gateway");

try

{

//Add your data

List nameValuePairs = new ArrayList(9);

nameValuePairs.add(new BasicNameValuePair("xKey", "")); //Credential

nameValuePairs.add(new BasicNameValuePair("xVersion", "4.5.8"));

nameValuePairs.add(new BasicNameValuePair("xSoftwareName", "")); //Name of your software

nameValuePairs.add(new BasicNameValuePair("xSoftwareVersion", "")); //Version of your software

nameValuePairs.add(new BasicNameValuePair("xCommand", "cc:sale"));

nameValuePairs.add(new BasicNameValuePair("xCardNum", ""));

nameValuePairs.add(new BasicNameValuePair("xExp", ""));

nameValuePairs.add(new BasicNameValuePair("xName", ""));

nameValuePairs.add(new BasicNameValuePair("xAmount", ""));

nameValuePairs.add(new BasicNameValuePair("xAccount", ""));

nameValuePairs.add(new BasicNameValuePair("xMagstripe", ""));

nameValuePairs.add(new BasicNameValuePair("xToken", ""));

nameValuePairs.add(new BasicNameValuePair("xCustom01", ""));

nameValuePairs.add(new BasicNameValuePair("xCVV", ""));

nameValuePairs.add(new BasicNameValuePair("xStreet", ""));

nameValuePairs.add(new BasicNameValuePair("xZip", ""));

nameValuePairs.add(new BasicNameValuePair("xBillFirstName", ""));

nameValuePairs.add(new BasicNameValuePair("xBillMiddleName", ""));

nameValuePairs.add(new BasicNameValuePair("xBillLastName", ""));

nameValuePairs.add(new BasicNameValuePair("xBillCompany", ""));

nameValuePairs.add(new BasicNameValuePair("xBillStreet", ""));

nameValuePairs.add(new BasicNameValuePair("xBillStreet2", ""));

nameValuePairs.add(new BasicNameValuePair("xBillCity", ""));

nameValuePairs.add(new BasicNameValuePair("xBillZip", ""));

nameValuePairs.add(new BasicNameValuePair("xBillCountry", ""));

nameValuePairs.add(new BasicNameValuePair("xBillPhone", ""));

nameValuePairs.add(new BasicNameValuePair("xBillMobile", ""));

nameValuePairs.add(new BasicNameValuePair("xShipFirstName", ""));

nameValuePairs.add(new BasicNameValuePair("xShipMiddleName", ""));

nameValuePairs.add(new BasicNameValuePair("xShipLastName", ""));

nameValuePairs.add(new BasicNameValuePair("xShipCompany", ""));

nameValuePairs.add(new BasicNameValuePair("xShipStreet", ""));

nameValuePairs.add(new BasicNameValuePair("xShipStreet2", ""));

nameValuePairs.add(new BasicNameValuePair("xShipCity", ""));

nameValuePairs.add(new BasicNameValuePair("xShipState", ""));

nameValuePairs.add(new BasicNameValuePair("xShipZip", ""));

nameValuePairs.add(new BasicNameValuePair("xShipCountry", ""));

nameValuePairs.add(new BasicNameValuePair("xShipPhone", ""));

nameValuePairs.add(new BasicNameValuePair("xShipMobile", ""));

nameValuePairs.add(new BasicNameValuePair("xRefNum", ""));

nameValuePairs.add(new BasicNameValuePair("xAuthCode", ""));

nameValuePairs.add(new BasicNameValuePair("xIP", ""));

nameValuePairs.add(new BasicNameValuePair("xRouting", ""));

nameValuePairs.add(new BasicNameValuePair("xCardpresent", ""));

nameValuePairs.add(new BasicNameValuePair("xDUKPT", ""));

nameValuePairs.add(new BasicNameValuePair("xTax", ""));

nameValuePairs.add(new BasicNameValuePair("xTip", ""));

nameValuePairs.add(new BasicNameValuePair("xInvoice", ""));

nameValuePairs.add(new BasicNameValuePair("xPONum", ""));

nameValuePairs.add(new BasicNameValuePair("xComments", ""));

nameValuePairs.add(new BasicNameValuePair("xDescription", ""));

nameValuePairs.add(new BasicNameValuePair("xEmail", ""));

nameValuePairs.add(new BasicNameValuePair("xFax", ""));

nameValuePairs.add(new BasicNameValuePair("xBillState", ""));

nameValuePairs.add(new BasicNameValuePair("xAllowPartialAuth", ""));

nameValuePairs.add(new BasicNameValuePair("xRxAmount", ""));

nameValuePairs.add(new BasicNameValuePair("xDentalAmount", ""));

nameValuePairs.add(new BasicNameValuePair("xVisionAmount", ""));

nameValuePairs.add(new BasicNameValuePair("xTransitAmount", ""));

nameValuePairs.add(new BasicNameValuePair("xCopayAmount", ""));

nameValuePairs.add(new BasicNameValuePair("xClinicalAmount", ""));

nameValuePairs.add(new BasicNameValuePair("xOrderID", ""));

nameValuePairs.add(new BasicNameValuePair("xExistingCustomer", ""));

nameValuePairs.add(new BasicNameValuePair("xAllowDuplicate", ""));

nameValuePairs.add(new BasicNameValuePair("xMICR", ""));

nameValuePairs.add(new BasicNameValuePair("xCheckNum", ""));

nameValuePairs.add(new BasicNameValuePair("xCheckImageFront", ""));

nameValuePairs.add(new BasicNameValuePair("xCheckImageBack", ""));

nameValuePairs.add(new BasicNameValuePair("xVoucherApproval", ""));

nameValuePairs.add(new BasicNameValuePair("xVoucherSerial", ""));

nameValuePairs.add(new BasicNameValuePair("xGatewayRefNum", ""));

nameValuePairs.add(new BasicNameValuePair("xGatewayResult", ""));

nameValuePairs.add(new BasicNameValuePair("xGatewayError", ""));

nameValuePairs.add(new BasicNameValuePair("xGatewayCVV", ""));

nameValuePairs.add(new BasicNameValuePair("xGatewayAVS", ""));

nameValuePairs.add(new BasicNameValuePair("xOrderItems", ""));

nameValuePairs.add(new BasicNameValuePair("xOrderType", ""));

nameValuePairs.add(new BasicNameValuePair("xCustomerComments", ""));

nameValuePairs.add(new BasicNameValuePair("xShipMethod", ""));

nameValuePairs.add(new BasicNameValuePair("xShipAmount", ""));

httppost.setEntity(new UrlEncodedFormEntity(nameValuePairs));

// Execute HTTP Post Request

HttpResponse response = httpclient.execute(httppost);

System.out.println("response = " + EntityUtils.toString(response.getEntity()));

}

catch (ClientProtocolException e)

{

// TODO Auto-generated catch block

}

catch (IOException e)

{

// TODO Auto-generated catch block

}

SAMPLE C# CODE

Only Show Variables

// Request

System.Collections.Specialized.NameValueCollection

MyPost = new System.Collections.Specialized.NameValueCollection();

MyPost.Add("xKey", ""); //Credential

MyPost.Add("xVersion", "4.5.8");

MyPost.Add("xSoftwareName", My.Application.Info.Title); //Name of your software

MyPost.Add("xSoftwareVersion", My.Application.Info.Version.ToString); //Version of your software

MyPost.Add("xCommand", "cc:sale");

MyPost.Add("xCardNum", "");

MyPost.Add("xExp", "");

MyPost.Add("xName", "");

MyPost.Add("xAmount", "");

MyPost.Add("xAccount", "");

MyPost.Add("xMagstripe", "");

MyPost.Add("xToken", "");

MyPost.Add("xCustom01", "");

MyPost.Add("xCVV", "");

MyPost.Add("xStreet", "");

MyPost.Add("xZip", "");

MyPost.Add("xBillFirstName", "");

MyPost.Add("xBillMiddleName", "");

MyPost.Add("xBillLastName", "");

MyPost.Add("xBillCompany", "");

MyPost.Add("xBillStreet", "");

MyPost.Add("xBillStreet2", "");

MyPost.Add("xBillCity", "");

MyPost.Add("xBillZip", "");

MyPost.Add("xBillCountry", "");

MyPost.Add("xBillPhone", "");

MyPost.Add("xBillMobile", "");

MyPost.Add("xShipFirstName", "");

MyPost.Add("xShipMiddleName", "");

MyPost.Add("xShipLastName", "");

MyPost.Add("xShipCompany", "");

MyPost.Add("xShipStreet", "");

MyPost.Add("xShipStreet2", "");

MyPost.Add("xShipCity", "");

MyPost.Add("xShipState", "");

MyPost.Add("xShipZip", "");

MyPost.Add("xShipCountry", "");

MyPost.Add("xShipPhone", "");

MyPost.Add("xShipMobile", "");

MyPost.Add("xRefNum", "");

MyPost.Add("xAuthCode", "");

MyPost.Add("xIP", "");

MyPost.Add("xRouting", "");

MyPost.Add("xCardpresent", "");

MyPost.Add("xDUKPT", "");

MyPost.Add("xTax", "");

MyPost.Add("xTip", "");

MyPost.Add("xInvoice", "");

MyPost.Add("xPONum", "");

MyPost.Add("xComments", "");

MyPost.Add("xDescription", "");

MyPost.Add("xEmail", "");

MyPost.Add("xFax", "");

MyPost.Add("xBillState", "");

MyPost.Add("xAllowPartialAuth", "");

MyPost.Add("xRxAmount", "");

MyPost.Add("xDentalAmount", "");

MyPost.Add("xVisionAmount", "");

MyPost.Add("xTransitAmount", "");

MyPost.Add("xCopayAmount", "");

MyPost.Add("xClinicalAmount", "");

MyPost.Add("xOrderID", "");

MyPost.Add("xExistingCustomer", "");

MyPost.Add("xAllowDuplicate", "");

MyPost.Add("xMICR", "");

MyPost.Add("xCheckNum", "");

MyPost.Add("xCheckImageFront", "");

MyPost.Add("xCheckImageBack", "");

MyPost.Add("xVoucherApproval", "");

MyPost.Add("xVoucherSerial", "");

MyPost.Add("xGatewayRefNum", "");

MyPost.Add("xGatewayResult", "");

MyPost.Add("xGatewayError", "");

MyPost.Add("xGatewayCVV", "");

MyPost.Add("xGatewayAVS", "");

MyPost.Add("xOrderItems", "");

MyPost.Add("xOrderType", "");

MyPost.Add("xCustomerComments", "");

MyPost.Add("xShipMethod", "");

MyPost.Add("xShipAmount", "");

System.Net.WebClient MyClient = new System.Net.WebClient();

string MyResponse = System.Text.UTF8Encoding.ASCII.GetString(MyClient.UploadValues("https://x1.cardknox.com/gateway", MyPost));

// Response

System.Collections.Specialized.NameValueCollection MyResponseData = System.Web.HttpUtility.ParseQueryString(MyResponse); //If necessary, add reference to System.Web

string MyResult = "";

if (MyResponseData.AllKeys.Contains("xResult"))

MyResult = MyResponseData["xResult"];

string MyStatus = "";

if (MyResponseData.AllKeys.Contains("xStatus"))

MyStatus = MyResponseData["xStatus"];

string MyError = "";

if (MyResponseData.AllKeys.Contains("xError"))

MyError = MyResponseData["xError"];

string MyRefNum = "";

if (MyResponseData.AllKeys.Contains("xRefNum"))

MyRefNum = MyResponseData["xRefNum"];

SAMPLE Python 2 CODE

Only Show Variables

# Python 2

import urllib2, urllib

from urlparse import parse_qs

data = {}

data["xKey"] = "" # Credential

data["xVersion"] = "" # API Version

data["xSoftwareName"] = "" # Name of your software

data["xSoftwareVersion"] = "" # Version of your software

data["xCommand"] = ""

data["xCardNum"] = ""

data["xExp"] = ""

data["xName"] = ""

data["xAmount"] = ""

data["xAccount"] = ""

data["xMagstripe"] = ""

data["xToken"] = ""

data["xCustom01"] = ""

data["xCVV"] = ""

data["xStreet"] = ""

data["xZip"] = ""

data["xBillFirstName"] = ""

data["xBillMiddleName"] = ""

data["xBillLastName"] = ""

data["xBillCompany"] = ""

data["xBillStreet"] = ""

data["xBillStreet2"] = ""

data["xBillCity"] = ""

data["xBillCountry"] = ""

data["xBillPhone"] = ""

data["xBillMobile"] = ""

data["xShipFirstName"] = ""

data["xShipMiddleName"] = ""

data["xShipCompany"] = ""

data["xShipStreet"] = ""

data["xShipStreet2"] = ""

data["xShipCity"] = ""

data["xShipState"] = ""

data["xShipZip"] = ""

data["xShipCountry"] = ""

data["xShipPhone"] = ""

data["xShipMobile"] = ""

data["xRefNum"] = ""

data["xAuthCode"] = ""

data["xIP"] = ""

data["xRouting"] = ""

data["xCardpresent"] = ""

data["xDUKPT"] = ""

data["xTax"] = ""

data["xTip"] = ""

data["xInvoice"] = ""

data["xPONum"] = ""

data["xComments"] = ""

data["xDescription"] = ""

data["xEmail"] = ""

data["xFax"] = ""

data["xBillState"] = ""

data["xAllowPartialAuth"] = ""

data["xRxAmount"] = ""

data["xDentalAmount"] = ""

data["xVisionAmount"] = ""

data["xTransitAmount"] = ""

data["xCopayAmount"] = ""

data["xClinicalAmount"] = ""

data["xOrderID"] = ""

data["xExistingCustomer"] = ""

data["xAllowDuplicate"] = ""

data["xMICR"] = ""

data["xCheckNum"] = ""

data["xCheckImageFront"] = ""

data["xCheckImageBack"] = ""

data["xVoucherApproval"] = ""

data["xVoucherSerial"] = ""

data["xGatewayRefNum"] = ""

data["xGatewayResult"] = ""

data["xGatewayError"] = ""

data["xGatewayCVV"] = ""

data["xGatewayAVS"] = ""

data["xOrderItems"] = ""

data["xOrderType"] = ""

data["xCustomerComments"] = ""

data["xShipMethod"] = ""

data["xShipAmount"] = ""

request = urllib2.Request("https://x1.cardknox.com/gateway", urllib.urlencode(data).encode('utf-8'))

rawResponse = urllib2.urlopen(request).read().decode('utf-8')

response = parse_qs(rawResponse, keep_blank_values=True)

print("xRefNum: " + "".join(response.get("xRefNum","")));

print("xResult: " + "".join(response.get("xResult","")));

print("xStatus: " + "".join(response.get("xStatus","")));

print("xError: " + "".join(response.get("xError","")));

SAMPLE Python 3 CODE

Only Show Variables

# Python 3

import urllib.request

from urllib.parse import parse_qs

data = {}

data["xKey"] = "" # Credential

data["xVersion"] = "" # API Version

data["xSoftwareName"] = "" # Name of your software

data["xSoftwareVersion"] = "" # Version of your software

data["xCommand"] = ""

data["xCardNum"] = ""

data["xExp"] = ""

data["xName"] = ""

data["xAmount"] = ""

data["xAccount"] = ""

data["xMagstripe"] = ""

data["xToken"] = ""

data["xCustom01"] = ""

data["xCVV"] = ""

data["xStreet"] = ""

data["xZip"] = ""

data["xBillFirstName"] = ""

data["xBillMiddleName"] = ""

data["xBillLastName"] = ""

data["xBillCompany"] = ""

data["xBillStreet"] = ""

data["xBillStreet2"] = ""

data["xBillCity"] = ""

data["xBillCountry"] = ""

data["xBillPhone"] = ""

data["xBillMobile"] = ""

data["xShipFirstName"] = ""

data["xShipMiddleName"] = ""

data["xShipCompany"] = ""

data["xShipStreet"] = ""

data["xShipStreet2"] = ""

data["xShipCity"] = ""

data["xShipState"] = ""

data["xShipZip"] = ""

data["xShipCountry"] = ""

data["xShipPhone"] = ""

data["xShipMobile"] = ""

data["xRefNum"] = ""

data["xAuthCode"] = ""

data["xIP"] = ""

data["xRouting"] = ""

data["xCardpresent"] = ""

data["xDUKPT"] = ""

data["xTax"] = ""

data["xTip"] = ""

data["xInvoice"] = ""

data["xPONum"] = ""

data["xComments"] = ""

data["xDescription"] = ""

data["xEmail"] = ""

data["xFax"] = ""

data["xBillState"] = ""

data["xAllowPartialAuth"] = ""

data["xRxAmount"] = ""

data["xDentalAmount"] = ""

data["xVisionAmount"] = ""

data["xTransitAmount"] = ""

data["xCopayAmount"] = ""

data["xClinicalAmount"] = ""

data["xOrderID"] = ""

data["xExistingCustomer"] = ""

data["xAllowDuplicate"] = ""

data["xMICR"] = ""

data["xCheckNum"] = ""

data["xCheckImageFront"] = ""

data["xCheckImageBack"] = ""

data["xVoucherApproval"] = ""

data["xVoucherSerial"] = ""

data["xGatewayRefNum"] = ""

data["xGatewayResult"] = ""

data["xGatewayError"] = ""

data["xGatewayCVV"] = ""

data["xGatewayAVS"] = ""

data["xOrderItems"] = ""

data["xOrderType"] = ""

data["xCustomerComments"] = ""

data["xShipMethod"] = ""

data["xShipAmount"] = ""

request = urllib.request.Request("https://x1.cardknox.com/gateway", urllib.parse.urlencode(data).encode('utf-8'))

rawResponse = urllib.request.urlopen(request).read().decode('utf-8')

response = parse_qs(rawResponse, keep_blank_values=True)

print("xRefNum: " + "".join(response.get("xRefNum","")));

print("xResult: " + "".join(response.get("xResult","")));

print("xStatus: " + "".join(response.get("xStatus","")));

print("xError: " + "".join(response.get("xError","")));

SAMPLE VB.NET CODE

Only Show Variables

'Request

Dim MyPost As New System.Collections.Specialized.NameValueCollection

MyPost.Add("xKey", "") ‘Credential

MyPost.Add("xVersion", "4.5.8")

MyPost.Add("xSoftwareName", My.Application.Info.Title) ‘Name of your software

MyPost.Add("xSoftwareVersion", My.Application.Info.Version.ToString) ‘Version of your software

MyPost.Add("xCommand", "cc:sale")

MyPost.Add("xCardNum", "")

MyPost.Add("xExp", "")

MyPost.Add("xName", "")

MyPost.Add("xAmount", "")

MyPost.Add("xAccount", "")

MyPost.Add("xMagstripe", "")

MyPost.Add("xToken", "")

MyPost.Add("xCustom01", "")

MyPost.Add("xCVV", "")

MyPost.Add("xStreet", "")

MyPost.Add("xZip", "")

MyPost.Add("xBillFirstName", "")

MyPost.Add("xBillMiddleName", "")

MyPost.Add("xBillLastName", "")

MyPost.Add("xBillCompany", "")

MyPost.Add("xBillStreet", "")

MyPost.Add("xBillStreet2", "")

MyPost.Add("xBillCity", "")

MyPost.Add("xBillZip", "")

MyPost.Add("xBillCountry", "")

MyPost.Add("xBillPhone", "")

MyPost.Add("xBillMobile", "")

MyPost.Add("xShipFirstName", "")

MyPost.Add("xShipMiddleName", "")

MyPost.Add("xShipLastName", "")

MyPost.Add("xShipCompany", "");

MyPost.Add("xShipStreet", "")

MyPost.Add("xShipStreet2", "")

MyPost.Add("xShipCity", "")

MyPost.Add("xShipState", "")

MyPost.Add("xShipZip", "")

MyPost.Add("xShipCountry", "")

MyPost.Add("xShipPhone", "")

MyPost.Add("xShipMobile", "")

MyPost.Add("xRefNum", "")

MyPost.Add("xAuthCode", "")

MyPost.Add("xIP", "")

MyPost.Add("xRouting", "")

MyPost.Add("xCardpresent", "")

MyPost.Add("xDUKPT", "")

MyPost.Add("xTax", "")

MyPost.Add("xTip", "")

MyPost.Add("xInvoice", "")

MyPost.Add("xPONum", "")

MyPost.Add("xComments", "")

MyPost.Add("xDescription", "")

MyPost.Add("xEmail", "")

MyPost.Add("xFax", "")

MyPost.Add("xBillState", "")

MyPost.Add("xAllowPartialAuth", "")

MyPost.Add("xRxAmount", "")

MyPost.Add("xDentalAmount", "")

MyPost.Add("xVisionAmount", "")

MyPost.Add("xTransitAmount", "")

MyPost.Add("xCopayAmount", "")

MyPost.Add("xClinicalAmount", "")

MyPost.Add("xOrderID", "")

MyPost.Add("xExistingCustomer", "")

MyPost.Add("xAllowDuplicate", "")

MyPost.Add("xMICR", "")

MyPost.Add("xCheckNum", "")

MyPost.Add("xCheckImageFront", "")

MyPost.Add("xCheckImageBack", "")

MyPost.Add("xVoucherApproval", "")

MyPost.Add("xVoucherSerial", "")

MyPost.Add("xGatewayRefNum", "")

MyPost.Add("xGatewayResult", "")

MyPost.Add("xGatewayError", "")

MyPost.Add("xGatewayCVV", "")

MyPost.Add("xGatewayAVS", "")

MyPost.Add("xOrderItems", "")

MyPost.Add("xOrderType", "")

MyPost.Add("xCustomerComments", "")

MyPost.Add("xShipMethod", "")

MyPost.Add("xShipAmount", "")

Dim MyClient As New Net.WebClient

Dim MyResponse As String = System.Text.UTF8Encoding.ASCII.GetString(MyClient.UploadValues("https://x1.cardknox.com/gateway", MyPost))

'Response

Dim MyResponseData As System.Collections.Specialized.NameValueCollection = System.Web.HttpUtility.ParseQueryString(MyResponse) 'If necessary, add reference to System.Web

Dim MyResult As String = ""

If MyResponseData.AllKeys.Contains("xResult") Then MyResult = MyResponseData("xResult")

Dim MyStatus As String = ""

If MyResponseData.AllKeys.Contains("xStatus") Then MyStatus = MyResponseData("xStatus")

Dim MyError As String = ""

If MyResponseData.AllKeys.Contains("xError") Then MyError = MyResponseData("xError")

Dim MyRefNum As String = ""

If MyResponseData.AllKeys.Contains("xRefNum") Then MyRefNum = MyResponseData("xRefNum")

CREDIT CARD

Sale

xCommand = cc:Sale
The Sale command is a combination of an authorization and capture and intended when fulfilling an order right away. For transactions that are not fulfilled right away, use the authonly command initially and use the capture command to complete the sale.

The card to be charged can be communicated with 3 different approaches: xCardNum + xExp OR xMagstripe OR xToken. Only one of these combinations can be used. Depending on a software or website’s security settings, cc:sale may also require xCVV, xStreet, or xZip and their related values.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xExp	Yes*	The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe	1249
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:sale
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xCVV	No	3-digit code from the back of the card (4-digit code from the front of the card for Amex).	123
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xCardpresent	No	Yes, No. For use in retail environments to indicate if the card is present.	No
xDUKPT	No	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	12345
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xAllowPartialAuth	No	True/False value indicating if an authorization amount is less than the initial request when full initial amount is unavailable. This variable is platform-dependent. Default is false.	True
xRxAmount	No	Specifies qualifying prescription amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xDentalAmount	No	Specifies qualifying dental amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xVisionAmount	No	Specifies qualifying vision amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xTransitAmount	No	Specifies qualifying transit amount for commuter card transactions. xAllowPartialAuth must be set to True.	1.50
xCopayAmount	No	Specifies copay amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xClinicalAmount	No	Specifies qualifying clinical amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True
xCustReceipt	No	True/False value indicating if the email address specificied in xemail should receive a receipt containing the transaction details.	False
xCurrency	No	Used to specify an alternate currency. Only applicable for accounts that are using Multi-Currency Conversion (MCC). For accounts that are natively in a foreign currency, the currency does not need to be specified. (supported currencies are: USD, GBP, ILS, EUR, MXN, CAD)	CAD

AuthOnly

xCommand = cc:AuthOnly
The AuthOnly command authorizes an amount on a cardholder’s account and places a hold on the available credit for that amount, but does not submit the charge for settlement. AuthOnly is used to reserve funds from a cardholder’s credit limit for a sale that is not ready to be processed. AuthOnly is commonly used when an order is placed on a website prior to the order being shipped or when a customer makes a hotel or car rental reservation. If the authorization amount exceeds the cardholder’s available credit, a rejected response will be returned. When successful, the authorization number is returned as RefNum and can be used to reference the authorization for a follow-up transaction. The funds will remain held until the authorization is either captured, voided, or expires. To settle an AuthOnly transaction and complete the sale, use the capture command. If an AuthOnly transaction is captured after 24 hours, it may be subject to a higher processing rate by the acquiring bank.

An AuthOnly hold only reduces the cardholder’s credit limit, but will not appear as a charge on their account. If the authorization will not be converted to a charge, Void Release can be used to release the hold prior to the expiration. The expiration timeframe varies by issuer, but is typically 7-30 days for credit cards and 3-5 days for debit cards.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xExp	Yes*	The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe	1249
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:authonly
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xCVV	No	3-digit code from the back of the card (4-digit code from the front of the card for Amex).	123
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xCardpresent	No	Yes, No. For use in retail environments to indicate if the card is present.	No
xDUKPT	No	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xAllowPartialAuth	No	True/False value indicating if an authorization amount is less than the initial request when full initial amount is unavailable. This variable is platform-dependent. Default is false.	True
xRxAmount	No	Specifies qualifying prescription amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xDentalAmount	No	Specifies qualifying dental amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xVisionAmount	No	Specifies qualifying vision amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xTransitAmount	No	Specifies qualifying transit amount for commuter card transactions. xAllowPartialAuth must be set to True.	1.50
xCopayAmount	No	Specifies copay amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xClinicalAmount	No	Specifies qualifying clinical amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True
xCustReceipt	No	True/False value indicating if the email address specificied in xemail should receive a receipt containing the transaction details.	False
xCurrency	No	Used to specify an alternate currency. Only applicable for accounts that are using Multi-Currency Conversion (MCC). For accounts that are natively in a foreign currency, the currency does not need to be specified. (supported currencies are: USD, GBP, ILS, EUR, MXN, CAD)	CAD

Capture

xCommand = cc:Capture
The Capture command is used to settle funds from a previous authorization and withdraw the funds from the cardholder’s account. The RefNumber from related authorization is required when submitting a Capture request. To perform an authorization and capture in the same command, use the Sale command.

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:capture
xAmount	No	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xRefNum	Yes	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568
xName	No	The cardholder’s name.	John Doe
xCardpresent	No	Yes, No. For use in retail environments to indicate if the card is present.	No
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True
xCustReceipt	No	True/False value indicating if the email address specificied in xemail should receive a receipt containing the transaction details.	False

Adjust

xCommand = cc:Adjust
The Adjust comand is used to change a previous authorization to a higher or lower amount. The RefNumber from related authorization is required when submitting an Adjust. Please Note: this command should only be used prior to capturing a transaction.

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:adjust
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xRefNum	Yes	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568
xName	No	The cardholder’s name.	John Doe
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1

Save

xCommand = cc:Save
The Save command is used to send account information and request a token from Cardknox, but does not submit the transaction for processing. The response returns a token which references that account information. A token at a minimum references the credit card number, but if other data is sent, such as billing address, that will be associated with the token as well.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xExp	Yes*	The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe	1249
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:save
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1

PostAuth

xCommand = cc:PostAuth
Some authorizations will require a voice authorization before they can be approved. When a verbal authorization is issued by the bank, that number can be sent with the PostAuth command to verify the authorization.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xExp	Yes*	The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe	1249
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:postauth
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xCVV	No	3-digit code from the back of the card (4-digit code from the front of the card for Amex).	123
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xAuthCode	Yes	xAuthCode is a verificaton number provided by the issuing bank to be used with the cc:postauth command.	T4321A
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xCardpresent	No	Yes, No. For use in retail environments to indicate if the card is present.	No
xDUKPT	No	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xAllowPartialAuth	No	True/False value indicating if an authorization amount is less than the initial request when full initial amount is unavailable. This variable is platform-dependent. Default is false.	True
xRxAmount	No	Specifies qualifying prescription amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xDentalAmount	No	Specifies qualifying dental amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xVisionAmount	No	Specifies qualifying vision amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xTransitAmount	No	Specifies qualifying transit amount for commuter card transactions. xAllowPartialAuth must be set to True.	1.50
xCopayAmount	No	Specifies copay amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xClinicalAmount	No	Specifies qualifying clinical amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True
xCurrency	No	Used to specify an alternate currency. Only applicable for accounts that are using Multi-Currency Conversion (MCC). For accounts that are natively in a foreign currency, the currency does not need to be specified. (supported currencies are: USD, GBP, ILS, EUR, MXN, CAD)	CAD

Credit

xCommand = cc:Credit
The Credit command refunds money from a merchant to a cardholder’s card that is not linked to any previous transaction.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xExp	Yes*	The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe	1249
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:credit
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xCVV	No	3-digit code from the back of the card (4-digit code from the front of the card for Amex).	123
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xCardpresent	No	Yes, No. For use in retail environments to indicate if the card is present.	No
xDUKPT	No	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True
xCustReceipt	No	True/False value indicating if the email address specificied in xemail should receive a receipt containing the transaction details.	False
xCurrency	No	Used to specify an alternate currency. Only applicable for accounts that are using Multi-Currency Conversion (MCC). For accounts that are natively in a foreign currency, the currency does not need to be specified. (supported currencies are: USD, GBP, ILS, EUR, MXN, CAD)	CAD

Refund

xCommand = cc:Refund
The Refund command is used to refund a full or partial amount of a previous transaction using xRefNum.

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:refund
xAmount	Yes	Refund amount. Can be equal or less than original transaction.	9.99
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xRefNum	Yes	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True
xCustReceipt	No	True/False value indicating if the email address specificied in xemail should receive a receipt containing the transaction details.	False

Void Refund

xCommand = cc:VoidRefund
The VoidRefund command will either void the pending transaction if it has not settled yet, or it will fully refund the transaction if it has already settled.

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:voidrefund
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xRefNum	Yes	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568

Void Release

xCommand = cc:VoidRelease
The Void Release command releases a pending authorization amount back to the cardholder’s credit limit without waiting for the standard authorization timeframe to expire.

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:voidrelease
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xRefNum	Yes	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568

Void

xCommand = cc:Void
The Void command voids a transaction that has not yet settled using xRefNum.

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	cc:void
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xRefNum	Yes	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568

CHECK (ACH)

Sale

xCommand = check:Sale
The Check Sale command debits funds from a customer’s checking or savings account using the account and routing number. The merchant must have a supported Check/ACH processing account

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	check:sale
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xRouting	Yes*	The check ABA Routing number.	021202337
xAccount	Yes*	The check Account number.	1234567890
xName	Yes	Name on account	John Doe
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xMICR	No	The routing, account and check number data from the bottom of a check in MICR (Magnetic Ink Character Recognition) format, typically generated by a check scanner.	t021000021t 123456789o _2542
xCheckNum	No	The Check number.	999
xCheckImageFront	No	The front image of the check, in Base 64 encoded image format.	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAUAQEAAAAAAAAAAAAAAAAAAAAA/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEQMRAD8AVIP/2Q==
xCheckImageBack	No	The back image of the check, in Base 64 encoded image format.	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAUAQEAAAAAAAAAAAAAAAAAAAAA/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEQMRAD8AVIP/2Q==
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True
xCustReceipt	No	True/False value indicating if the email address specificied in xemail should receive a receipt containing the transaction details.	False
xCurrency	No	Used to specify an alternate currency. Only applicable for accounts that are using Multi-Currency Conversion (MCC). For accounts that are natively in a foreign currency, the currency does not need to be specified. (supported currencies are: USD, GBP, ILS, EUR, MXN, CAD)	CAD

Credit

xCommand = check:Credit
The Credit command sends money from a merchant to a customer’s bank account that is not linked to any previous transaction. With check transactions, this is commonly used for paying 3rd-parties such as paying vendors. To refund a previous check sale, use Check:Refund instead.

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	check:credit
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xRouting	Yes*	The check ABA Routing number.	021202337
xAccount	Yes*	The check Account number.	1234567890
xName	Yes	The cardholder’s name.	John Doe
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xMICR	No	The routing, account and check number data from the bottom of a check in MICR (Magnetic Ink Character Recognition) format, typically generated by a check scanner.	t021000021t 123456789o _2542
xCheckNum	No	The Check number.	999
xCheckImageFront	No	The front image of the check, in Base 64 encoded image format.	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAUAQEAAAAAAAAAAAAAAAAAAAAA/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEQMRAD8AVIP/2Q==
xCheckImageBack	No	The back image of the check, in Base 64 encoded image format.	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAUAQEAAAAAAAAAAAAAAAAAAAAA/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEQMRAD8AVIP/2Q==
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True
xCustReceipt	No	True/False value indicating if the email address specificied in xemail should receive a receipt containing the transaction details.	False
xCurrency	No	Used to specify an alternate currency. Only applicable for accounts that are using Multi-Currency Conversion (MCC). For accounts that are natively in a foreign currency, the currency does not need to be specified. (supported currencies are: USD, GBP, ILS, EUR, MXN, CAD)	CAD

Save

xCommand = check:Save
The Save command is used to send account information and request a token from Cardknox, but does not submit the transaction for processing. The response returns a token which references that account information. A token at a minimum references the account and routing number, but if other data is sent, such as billing address, that will be associated with the token as well.

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	check:save
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xRouting	Yes*	The check ABA Routing number.	021202337
xAccount	Yes*	The check Account number.	1234567890
xName	Yes	The cardholder’s name.	John Doe
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xMICR	No	The routing, account and check number data from the bottom of a check in MICR (Magnetic Ink Character Recognition) format, typically generated by a check scanner.	t021000021t 123456789o _2542
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

Void

xCommand = check:Void
The Void command voids a check transaction that is pending being sent to the bank, typically at the end of each day.

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	check:void
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xName	Yes	The cardholder’s name.	John Doe
xRefNum	Yes	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1

Refund

xCommand = check:Refund
The Refund command is used to refund a full or partial refund of a previous settled check transaction, using xRefNum.

Variable	Required	Description	Sample Data
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	check:refund
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xRefNum	Yes	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True
xCustReceipt	No	True/False value indicating if the email address specificied in xemail should receive a receipt containing the transaction details.	False

EBT Food Stamp

Sale

xCommand = ebtfs:sale
The Sale command is used to make a purchase on an EBT cardholder’s food stamp account.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.5	4.5.5
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	ebtfs:sale
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xDUKPT	Yes	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True
xCustReceipt	No	True/False value indicating if the email address specificied in xemail should receive a receipt containing the transaction details.	False

Credit

xCommand = ebtfs:credit
The Credit command is used to credit to an EBT cardholder’s food stamp account.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.5	4.5.5
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	ebtfs:credit
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xDUKPT	Yes	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

Balance

xCommand = ebtfs:balance
The Balance command is used to check the balance on an EBT food stamp card.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.5	4.5.5
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	ebtfs:balance
xDUKPT	Yes	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1

Voucher

xCommand = ebtfs:voucher
The Voucher command is used to process manual EBT food stamp voucher.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.5	4.5.5
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	ebtfs:voucher
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xDUKPT	Yes	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xVoucherApproval	Yes	The EBT voucher approval code.	123df1248f
xVoucherSerial	Yes	The EBT voucher serial number.	123
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

EBT Cash Benefits

Sale

xCommand = ebtcb:sale
The Sale command is used to make a purchase on an EBT cardholder’s cash benefit account.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.5	4.5.5
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	ebtcb:sale
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xDUKPT	Yes	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

Cash

xCommand = ebtcb:Cash
The Cash command enables a cash withdrawal from on an EBT cardholder’s cash benefit account.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.5	4.5.5
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	ebtcb:cash
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xDUKPT	Yes	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

Balance

xCommand = ebtcb:Balance
The Balance command is used to check the balance on an EBT cash benefit account.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.5	4.5.5
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	ebtcb:balance
xDUKPT	Yes	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1

EBT Wic (eWic)

Sale

xCommand = ebtw:sale
The Sale command is used to make a purchase on an EBTW cardholder’s cash benefit account.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.5	4.5.5
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	ebtw:sale
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
x1UnitPrice	Yes	Unit price for item specified in xUPC. Additional items can be specified by incrementing (i.e x2UnitPrice, x3UnitPrice, etc.)	2.5
x1Qty	Yes	Quantity of item specified in xUPC. Additional items can be specified by incrementing (i.e x2Qty, x3Qty, etc.)	2
x1Upc	Yes	Universal Product Code. Additional items can be specified by incrementing (i.e x2Upc, x3Upc, etc.)	075457026002
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xDUKPT	Yes	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xMagstripe	No*	The magstripe data of an eWIC card. When using xMagstripe, xCardNum and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

Balance

xCommand = ebtw:Balance
The Cash Balance enables a cash withdrawal from on an EBTW cardholder’s cash benefit account.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.5	4.5.5
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	ebtw:balance
xDUKPT	Yes	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xMagstripe	No*	The magstripe data of an eWIC card. When using xMagstripe, xCardNum and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1

Void

xCommand = ebtw:Void
The Balance command is used to check the balance on an EBTW cash benefit account.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.5	4.5.5
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	ebtw:void
xDUKPT	Yes	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xRefNum	Yes	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1

GIFT CARD

Issue

xCommand = gift:issue
The Issue command is used to issue funds to a Cardknox gift card.

Variable	Required	Description	Sample Data
xCardNum	Yes*	Gift card number. *Alternatively, xMagstripe or xToken can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	gift:issue
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used card. When using this variable, xCardNum,and xMagstripe should not be used. (Max 50 Alphanumeric Characters)	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xExp	No	Gift card expiration number. Format: MMYY. For sandbox accounts, use any date in the future. *Required and available only when xCardNum is used.	1249
xCVV	No	3-digit code from the back of the card (4-digit code from the front of the card for Amex).	123
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xCardpresent	No	Yes, No. For use in retail environments to indicate if the card is present.	No
xDUKPT	No	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

Redeem

xCommand = gift:redeem
The Redeem command is used to debit funds from a Cardknox gift card.

Variable	Required	Description	Sample Data
xCardNum	Yes*	Gift card number. *Alternatively, xMagstripe or xToken can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	gift:redeem
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xToken	No*	The Cardknox token that references a previously used card. When using this variable, xCardNum,and xMagstripe should not be used. (Max 50 Alphanumeric Characters)	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xExp	No	Gift card expiration number. Format: MMYY. For sandbox accounts, use any date in the future. *Required and available only when xCardNum is used.	1249
xCVV	No	3-digit code from the back of the card (4-digit code from the front of the card for Amex).	123
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xCardpresent	No	Yes, No. For use in retail environments to indicate if the card is present.	No
xDUKPT	No	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

Balance

xCommand = gift:balance
The Balance command is used to check the available balance on a Cardknox gift card.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	gift:balance
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xExp	No*	The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe	1249
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xCVV	No	3-digit code from the back of the card (4-digit code from the front of the card for Amex).	123
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xAuthCode	No	xAuthCode is a verificaton number provided by the issuing bank to be used with the cc:postauth command.	T4321A
xCardpresent	No	Yes, No. For use in retail environments to indicate if the card is present.	No
xDUKPT	No	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xRefNum	No	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xMICR	No	The routing, account and check number data from the bottom of a check in MICR (Magnetic Ink Character Recognition) format, typically generated by a check scanner.	t021000021t 123456789o _2542
xRouting	No	The check ABA Routing number.	021202337
xAccount	No	The check Account number.	1234567890
xCheckNum	No	The Check number.	999
xCheckImageFront	No	The front image of the check, in Base 64 encoded image format.	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAUAQEAAAAAAAAAAAAAAAAAAAAA/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEQMRAD8AVIP/2Q==
xCheckImageBack	No	The back image of the check, in Base 64 encoded image format.	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAUAQEAAAAAAAAAAAAAAAAAAAAA/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEQMRAD8AVIP/2Q==
xVoucherApproval	No	The EBT voucher approval code.	123df1248f
xVoucherSerial	No	The EBT voucher serial number.	123
xAllowPartialAuth	No	True/False value indicating if an authorization amount is less than the initial request when full initial amount is unavailable. This variable is platform-dependent. Default is false.	True
xRxAmount	No	Specifies qualifying prescription amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xDentalAmount	No	Specifies qualifying dental amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xVisionAmount	No	Specifies qualifying vision amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xTransitAmount	No	Specifies qualifying transit amount for commuter card transactions. xAllowPartialAuth must be set to True.	1.50
xCopayAmount	No	Specifies copay amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xClinicalAmount	No	Specifies qualifying clinical amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xGatewayRefNum	No	Transaction RefNum received from Gateway for FraudWatch verification.	852585258
xGatewayResult	No	Transaction status received from gateway for FraudWatch verification. (Approved/Declined/Error)	Approved
xGatewayError	No	Transaction RefNum received from Gateway for FraudWatch verification.	845455484
xGatewayCVV	No	CVV for for FraudWatch verification.	M
xGatewayAVS	No	Street Address for FraudWatch verification.	YYY
xOrderType	No	Specifies if the order origin is Internet OR Phone for FraudWatch verification.	Internet
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xOrderItems	No	Summary of products ordered.	Sony Digital Camera
xCustomerComments	No	Comments submitted by customer along with order.	Please ship as soon as possible
x1UnitPrice	No	Unit price for item specified in xUPC. Additional items can be specified by incrementing (i.e x2UnitPrice, x3UnitPrice, etc.)
x1Qty	No	Quantity of item specified in xUPC. Additional items can be specified by incrementing (i.e x2Qty, x3Qty, etc.)
x1Upc	No	Universal Product Code. Additional items can be specified by incrementing (i.e x2Upc, x3Upc, etc.)
xShipMethod	No	The shipping carrier/service used.	UPS Ground
xShipAmount	No	The total cost of shipping charges.	29.99
xShipEmail	No	The ShipTo email address.	example@example.com
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

Activate

xCommand = gift:activate
The Activate command is used to activate a Cardknox gift card.

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	gift:balance
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xExp	No*	The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe	1249
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xCVV	No	3-digit code from the back of the card (4-digit code from the front of the card for Amex).	123
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xAuthCode	No	xAuthCode is a verificaton number provided by the issuing bank to be used with the cc:postauth command.	T4321A
xCardpresent	No	Yes, No. For use in retail environments to indicate if the card is present.	No
xDUKPT	No	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xRefNum	No	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xMICR	No	The routing, account and check number data from the bottom of a check in MICR (Magnetic Ink Character Recognition) format, typically generated by a check scanner.	t021000021t 123456789o _2542
xRouting	No	The check ABA Routing number.	021202337
xAccount	No	The check Account number.	1234567890
xCheckNum	No	The Check number.	999
xCheckImageFront	No	The front image of the check, in Base 64 encoded image format.	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAUAQEAAAAAAAAAAAAAAAAAAAAA/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEQMRAD8AVIP/2Q==
xCheckImageBack	No	The back image of the check, in Base 64 encoded image format.	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAUAQEAAAAAAAAAAAAAAAAAAAAA/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEQMRAD8AVIP/2Q==
xVoucherApproval	No	The EBT voucher approval code.	123df1248f
xVoucherSerial	No	The EBT voucher serial number.	123
xAllowPartialAuth	No	True/False value indicating if an authorization amount is less than the initial request when full initial amount is unavailable. This variable is platform-dependent. Default is false.	True
xRxAmount	No	Specifies qualifying prescription amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xDentalAmount	No	Specifies qualifying dental amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xVisionAmount	No	Specifies qualifying vision amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xTransitAmount	No	Specifies qualifying transit amount for commuter card transactions. xAllowPartialAuth must be set to True.	1.50
xCopayAmount	No	Specifies copay amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xClinicalAmount	No	Specifies qualifying clinical amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xGatewayRefNum	No	Transaction RefNum received from Gateway for FraudWatch verification.	852585258
xGatewayResult	No	Transaction status received from gateway for FraudWatch verification. (Approved/Declined/Error)	Approved
xGatewayError	No	Transaction RefNum received from Gateway for FraudWatch verification.	845455484
xGatewayCVV	No	CVV for for FraudWatch verification.	M
xGatewayAVS	No	Street Address for FraudWatch verification.	YYY
xOrderType	No	Specifies if the order origin is Internet OR Phone for FraudWatch verification.	Internet
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xOrderItems	No	Summary of products ordered.	Sony Digital Camera
xCustomerComments	No	Comments submitted by customer along with order.	Please ship as soon as possible
x1UnitPrice	No	Unit price for item specified in xUPC. Additional items can be specified by incrementing (i.e x2UnitPrice, x3UnitPrice, etc.)
x1Qty	No	Quantity of item specified in xUPC. Additional items can be specified by incrementing (i.e x2Qty, x3Qty, etc.)
x1Upc	No	Universal Product Code. Additional items can be specified by incrementing (i.e x2Upc, x3Upc, etc.)
xShipMethod	No	The shipping carrier/service used.	UPS Ground
xShipAmount	No	The total cost of shipping charges.	29.99
xShipEmail	No	The ShipTo email address.	example@example.com
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

Deactivate

xCommand = gift:deactivate
The Deactivate command is used to deactivate a Cardknox gift card.(Note: you can still check the balance of the gift card even after it has been deactivated.)

Variable	Required	Description	Sample Data
xCardNum	Yes*	The customer card number. *Alternatively, xToken or xMagStripe can be used.	4444333322221111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	gift:balance
xToken	No*	The Cardknox token that references a previously used payment method. When using a token, xCardNum, xExp and xMagstripe should not be used.	61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84
xExp	No*	The card expiration number. Format: MMYY. For sandbox test transactions, use any date in the future. *xExp is required when sending in xCardnum and cannot be used with xMagstripe	1249
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xCVV	No	3-digit code from the back of the card (4-digit code from the front of the card for Amex).	123
xStreet	No	The billing street address of the cardholder.	123 Any Street
xZip	No	The billing zip code of the cardholder.	11111
xMagstripe	No*	The magstripe data of a credit card. Magstripe data includes the card number and expiration date. When using this command, xCardNum, xExp and xToken should not be used. Encrypted Card data can also be sent using xMagstripe.	%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?
xName	No	The cardholder’s name.	John Doe
xAuthCode	No	xAuthCode is a verificaton number provided by the issuing bank to be used with the cc:postauth command.	T4321A
xCardpresent	No	Yes, No. For use in retail environments to indicate if the card is present.	No
xDUKPT	No	The DUK/PT key for PIN Debit and EBT transactions.The first 16 characters are the encrypted pin block, followed by the 6 character long Key Set Identifier (KSID). The remaining characters are the PIN Pad serial number and transaction counter.
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xRefNum	No	Used to reference a previous transaction when doing a follow-up transaction, typically a refund, void, or capture. (Note: xRefnum can be a 64-bit number and should be stored as BIGINT, Long, Int64 or String)	81234568
xInvoice	No	The merchant’s invoice number for the transaction. xInvoice is recommended when available for improved duplicate handling.	123456A
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xIP	No	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	No	The customer’s email address.	test@example.com
xFax	No	The customer’s fax number.	8885551212
xBillFirstName	No	The customer’s first name for their billing profile.	John
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillLastName	No	The customer’s last/family name for their billing profile.	Doe
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet	No	The customer’s street address for their billing profile.	123 Any Street
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCity	No	The customer’s city for their billing profile.	Anytown
xBillState	No	The customer’s state for their billing profile.	NY
xBillZip	No	The customer’s zip code for their billing profile.	11111
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillPhone	No	The customer’s phone number for their billing profile.	8005551212
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipFirstName	No	The customer’s first name for their shipping profile.	John
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipLastName	No	The customer’s last/family name for their shipping profile.	Doe
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet	No	The customer’s street address for their shipping profile.	123 Any Street
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCity	No	The customer’s city for their shipping profile.	Anytown
xShipState	No	The customer’s state for their shipping profile.	NY
xShipZip	No	The customer’s zip code for their shipping profile.	11111
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipPhone	No	The customer’s phone number for their shipping profile.	8005551212
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xMICR	No	The routing, account and check number data from the bottom of a check in MICR (Magnetic Ink Character Recognition) format, typically generated by a check scanner.	t021000021t 123456789o _2542
xRouting	No	The check ABA Routing number.	021202337
xAccount	No	The check Account number.	1234567890
xCheckNum	No	The Check number.	999
xCheckImageFront	No	The front image of the check, in Base 64 encoded image format.	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAUAQEAAAAAAAAAAAAAAAAAAAAA/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEQMRAD8AVIP/2Q==
xCheckImageBack	No	The back image of the check, in Base 64 encoded image format.	data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/wAARCAABAAEDAREAAhEBAxEB/8QAFAABAAAAAAAAAAAAAAAAAAAACP/EABQQAQAAAAAAAAAAAAAAAAAAAAD/xAAUAQEAAAAAAAAAAAAAAAAAAAAA/8QAFBEBAAAAAAAAAAAAAAAAAAAAAP/aAAwDAQACEQMRAD8AVIP/2Q==
xVoucherApproval	No	The EBT voucher approval code.	123df1248f
xVoucherSerial	No	The EBT voucher serial number.	123
xAllowPartialAuth	No	True/False value indicating if an authorization amount is less than the initial request when full initial amount is unavailable. This variable is platform-dependent. Default is false.	True
xRxAmount	No	Specifies qualifying prescription amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xDentalAmount	No	Specifies qualifying dental amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xVisionAmount	No	Specifies qualifying vision amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xTransitAmount	No	Specifies qualifying transit amount for commuter card transactions. xAllowPartialAuth must be set to True.	1.50
xCopayAmount	No	Specifies copay amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xClinicalAmount	No	Specifies qualifying clinical amount for FSA transactions. xAllowPartialAuth must be set to True.	1.50
xGatewayRefNum	No	Transaction RefNum received from Gateway for FraudWatch verification.	852585258
xGatewayResult	No	Transaction status received from gateway for FraudWatch verification. (Approved/Declined/Error)	Approved
xGatewayError	No	Transaction RefNum received from Gateway for FraudWatch verification.	845455484
xGatewayCVV	No	CVV for for FraudWatch verification.	M
xGatewayAVS	No	Street Address for FraudWatch verification.	YYY
xOrderType	No	Specifies if the order origin is Internet OR Phone for FraudWatch verification.	Internet
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xExistingCustomer	No	Yes/No value indicating if customer is a repeat customer.	No
xOrderItems	No	Summary of products ordered.	Sony Digital Camera
xCustomerComments	No	Comments submitted by customer along with order.	Please ship as soon as possible
x1UnitPrice	No	Unit price for item specified in xUPC. Additional items can be specified by incrementing (i.e x2UnitPrice, x3UnitPrice, etc.)
x1Qty	No	Quantity of item specified in xUPC. Additional items can be specified by incrementing (i.e x2Qty, x3Qty, etc.)
x1Upc	No	Universal Product Code. Additional items can be specified by incrementing (i.e x2Upc, x3Upc, etc.)
xShipMethod	No	The shipping carrier/service used.	UPS Ground
xShipAmount	No	The total cost of shipping charges.	29.99
xShipEmail	No	The ShipTo email address.	example@example.com
xAllowDuplicate	No	By default, Cardknox rejects duplicate transactions within 10 minutes of the original transaction. This command overrides that safeguard. True/False allowed.	True

FRAUD

Fraud Submit

xCommand = fraud:submit
The Submit command is used in conjunction with a valid FraudWatch account to submit ecommerce transactions for a fraud verification check.

Variable	Required	Description	Sample Data
xCardNum	Yes*	Masked Card number with BIN and last 4 digits exposed	444433xxxxxx1111
xKey	Yes	Your Cardknox API Key.	[xkeycredentials]
xVersion	Yes	Gateway API Version. The current version is 4.5.8	4.5.8
xSoftwareName	Yes	Name of your software.	[xsoftwarecredentials]
xSoftwareVersion	Yes	Version number of your software.	[xversioncredentials]
xCommand	Yes	Cardknox transaction type.	fraud:submit
xAmount	Yes	The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction.	9.99
xCustom01	No	20 custom fields are available for custom data such as customer comments, etc. Use xCustom01 through xCustom20.	Register01
xInvoice	Yes	Invoice number	123456A
xIP	Yes	The customer’s IP address. Typically used for fraud detection.	1.1.1.1
xEmail	Yes	Customer billing email.	test@example.com
xBillFirstName	Yes	The customer’s first name for their billing profile.	John
xBillLastName	Yes	The customer’s last/family name for their billing profile.	Doe
xBillStreet	Yes	The customer’s street address for their billing profile.	123 Any Street
xBillCity	Yes	The customer’s city for their billing profile.	Anytown
xBillState	Yes	The customer’s state for their billing profile.	NY
xBillZip	Yes	The customer’s zip code for their billing profile.	11111
xBillPhone	Yes	The customer’s phone number for their billing profile.	8005551212
xShipFirstName	Yes	The customer’s first name for their shipping profile.	John
xShipLastName	Yes	The customer’s last/family name for their shipping profile.	Doe
xShipStreet	Yes	The customer’s street address for their shipping profile.	123 Any Street
xShipCity	Yes	The customer’s city for their shipping profile.	Anytown
xShipState	Yes	The customer’s state for their shipping profile.	NY
xShipZip	Yes	The customer’s zip code for their shipping profile.	11111
xShipPhone	Yes	The customer’s phone number for their shipping profile.	8005551212
xGatewayRefNum	Yes	Transaction RefNum received from Gateway for FraudWatch verification.	852585258
xGatewayResult	Yes	Transaction status received from gateway for FraudWatch verification. (Approved/Declined/Error)	Approved
xGatewayCVV	Yes	CVV for for FraudWatch verification.	M
xGatewayAVS	Yes	Street Address for FraudWatch verification.	YYY
xOrderType	Yes	Specifies if the order origin is Internet OR Phone for FraudWatch verification.	Internet
xExistingCustomer	Yes	Yes/No value indicating if customer is a repeat customer.	No
xShipEmail	Yes	The ShipTo email address.	example@example.com
xName	No	The cardholder’s name.	John Doe
xTax	No	The tax portion that is included in the total transaction amount (xAmount).	.05
xTip	No	The tip portion that is included in the total transaction amount (xAmount).	.05
xPONum	No	The merchant’s purchase order number for the transaction.	123485B
xComments	No	Additional data optionally passed along to the receipt.	This is a comment
xDescription	No	Additional data optionally passed along for reporting.	This is a description
xFax	No	The customer’s fax number.	8885551212
xBillMiddleName	No	The customer’s middle name or initial for their billing profile.	Max
xBillCompany	No	The customer’s company name for their billing profile.	Acme
xBillStreet2	No	The customer’s street address 2nd line for their billing profile.	Apt 4b
xBillCountry	No	The customer’s Country for their billing profile.	USA
xBillMobile	No	The customer’s mobile number for their billing profile.	8005551111
xShipMiddleName	No	The customer’s middle name or initial for their shipping profile.	Max
xShipCompany	No	The customer’s company name for their shipping profile.	Acme
xShipStreet2	No	The customer’s street address 2nd line for their shipping profile.	Apt 4b
xShipCountry	No	The customer’s Country for their shipping profile.	USA
xShipMobile	No	The customer’s mobile number for their shipping profile.	8005551111
xGatewayError	No	Transaction RefNum received from Gateway for FraudWatch verification.	845455484
xOrderID	No	Unique Order Number for FraudWatch verification.	12356
xOrderItems	No	Summary of products ordered.	Sony Digital Camera
xCustomerComments	No	Comments submitted by customer along with order.	Please ship as soon as possible
xShipMethod	No	The shipping carrier/service used.	UPS Ground
xShipAmount	No	The total cost of shipping charges.	29.99

API Documentation

API INTRODUCTION

Overview

iFields

Credentials

Endpoints

Request Method

Tokenization

Batches

Response Parameters

Sample Code Generator

CREDIT CARD

Sale

AuthOnly

Capture

Adjust

Save

PostAuth

Credit

Refund

Void Refund

Void Release

Void

CHECK (ACH)

Sale

Credit

Save

Void

Refund

EBT Food Stamp

Sale

Credit

Balance

Voucher

EBT Cash Benefits

Sale

Cash

Balance

EBT Wic (eWic)

Sale

Balance

Void

GIFT CARD

Issue

Redeem

Balance

Activate

Deactivate

FRAUD

Fraud Submit

Sample Code Generator