Transaction API (V2)

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. You can find emulator endpoints here.

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 are required on each request.

Getting started

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.

Credit Card

get
https://x1.cardknox.com/gateway/sale
Sale
get
https://x1.cardknox.com/gateway
AuthOnly
get
https://x1.cardknox.com/gateway
Capture
get
https://x1.cardknox.com/gateway
Adjust
get
https://x1.cardknox.com/gateway
Save
get
https://x1.cardknox.com/gateway
PostAuth
get
https://x1.cardknox.com/gateway
Credit
get
https://x1.cardknox.com/gateway
Refund
get
https://x1.cardknox.com/gateway
VoidRefund
get
https://x1.cardknox.com/gateway
VoidRelease
get
https://x1.cardknox.com/gateway
Void
Sale
AuthOnly
Capture
Adjust
Save
PostAuth
Credit
Refund
Void Refund
Void Release
Void
Untitled
{
"xCardNum": "4444333322221111",
"xExp": "1030",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:sale",
"xAmount": "35.00",
"token": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xCVV": "123",
"xStreet": "123 Main Street",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUPKT":
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xAllowPartialAuth": "TRUE",
"xRxAmount": "1.50",
"xDentalAmount": "1.50",
"xVisionAmount": "1.50",
"xTransitAmount": "1.50",
"xCopayAmount": "1.50",
"xClinicalAmount": "1.50",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE",
"xCurrency": "USD"
}
{
"xCardNum": "4444333322221111",
"xExp": "1030",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:authonly",
"xAmount": "35.00",
"token": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xCVV": "123",
"xStreet": "123 Main Street",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUPKT":
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xAllowPartialAuth": "TRUE",
"xAutoRentalPickupDate": "2020-08-21",
"xAutoRentalPickupTime": "11:15:00",
"xAutoRentalReturnDate": "2020-08-21",
"xAutoRentalReturnTime": "11:15:00",
"xRxAmount": "1.50",
"xDentalAmount": "1.50",
"xVisionAmount": "1.50",
"xTransitAmount": "1.50",
"xCopayAmount": "1.50",
"xClinicalAmount": "1.50",
"xOrderID": "12356",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE",
"xCurrency": "USD"
}
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:capture",
"xAmount": "35.00",
"xCustom01": "Register01",
"xCVV": "123",
"xStreet": "123 Main Street",
"xZip": "12345",
"xRefNum": "81234568",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE"
}
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:adjust",
"xAmount": "35.00",
"xCustom01": "Register01",
"xCustom02": "Register01",
"xCustom03": "Register01",
"xStreet": "123 Main Street",
"xZip": "12345",
"xRefNum": "81234568",
"xName": "John Doe",
"xDescription": "This is a description",
"OrderID": "123456",
"xTip": "1.05",
"xTax": "1.05",
"xSignature": "aGVsbG8gaG93IGFyZSB5b3UK",
"xInvoice": "123456A"
}
{
"xCardNum": "444433322221111",
"xExp": "1249",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:save",
"xCustom01": "Register01",
"xStreet": "123 Main Street",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xIP": "1.1.1.1"
}
{
"xCardNum": "4444333322221111",
"xExp": "1030",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:postauth",
"xAmount": "35.00",
"token": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xCVV": "123",
"xStreet": "123 Main Street",
"xZip": "12345",
"xAuthCode": "T4321A",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUPKT":
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xAllowPartialAuth": "TRUE",
"xRxAmount": "1.50",
"xDentalAmount": "1.50",
"xVisionAmount": "1.50",
"xTransitAmount": "1.50",
"xCopayAmount": "1.50",
"xClinicalAmount": "1.50",
"xOrderID": "12356",
"xExistingCustomer": "No",
"xAllowDuplicate": "TRUE",
"xCurrency": "USD"
}
{
"xCardNum": "4444333322221111",
"xExp": "1030",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:credit",
"xAmount": "35.00",
"token": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xCVV": "123",
"xStreet": "123 Main Street",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUPKT":
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xAllowPartialAuth": "TRUE",
"xRxAmount": "1.50",
"xDentalAmount": "1.50",
"xVisionAmount": "1.50",
"xTransitAmount": "1.50",
"xCopayAmount": "1.50",
"xClinicalAmount": "1.50",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE",
"xCurrency": "USD"
}
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:refund",
"xAmount": "35.00",
"xCustom01": "Register01",
"xRefNum": "93827163",
"xDescription": "This is a description",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "FALSE",
"xCurrency": "USD"
}
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:voidrefund",
"xCustom01": "Register01",
"xRefNum": "93827163"
}
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:voidrelease",
"xCustom01": "Register01",
"xRefNum": "93827163"
}
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:sale",
"xCustom01": "Register01",
"xRefNum": "93827163"
}

Check (ACH)

get
https://
x1.cardknox.com/gateway
Sale
get
https://
x1.cardknox.com/gateway/
Credit
get
https://x1.cardknox.com/gateway
Save
get
https://x1.cardknox.com/gateway
Void
get
https://x1.cardknox.com/gateway/void
Refund
Sale
Credit
Save
Void
Refund
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "check:sale",
"xAmount": "35.00",
"token": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xRouting": "12345678",
"xAccount": "123456789",
"xAccountType": "Checking",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xMICR": "t021000021t 123456789o _2542",
"xCheckNum": "999",
"xCheckImageFront": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/w",
"xCheckImageRear": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/w",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE",
"xCurrency": "USD"
}
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "check.credit",
"xAmount": "35.00",
"token": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xRouting": "12345678",
"xAccount": "123456789",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xMICR": "t021000021t 123456789o _2542",
"xCheckNum": "999",
"xCheckImageFront": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/w",
"xCheckImageRear": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBAQFBAYFBQYJBgUGCQsIBgYICwwKCgsKCgwQDAwMDAwMEAwODxAPDgwTExQUExMcGxsbHCAgICAgICAgICD/2wBDAQcHBw0MDRgQEBgaFREVGiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICD/w",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE",
"xCurrency": "USD"
}
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "check.save",
"xCustom01": "Register01",
"xRouting": "12345678",
"xAccount": "123456789",
"xName": "John Doe",
"xIP": "1.2.3.4",
"xMICR": "t021000021t 123456789o _2542",
"xAllowDuplicate": "TRUE"
}
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "check.void",
"xCustom01": "Register01",
"xRefNum": "81726356",
"xIP": "1.1.1.1"
}
{
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "check.refund",
"xAmount": "9.99",
"xCustom01": "Register01",
"xRefNum": "81726356",
"xIP": "1.1.1.1",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "FALSE"

Check (ACH) FAQ

Q: How many days does it take to get the ACH status?

A: It typically takes 2-3 days.

Q: How can I get the ACH status?

A: There are a few ways to get status. Email, Webhook, Cardknox Portal, or you pull a report using our reporting API.

Q: What verbiage comes back from the ACH Status?

A: In Cardknox you should get back the following status codes:
  • xStatus=16 “settled”
  • xStatus=14 “chargeback”
  • xStatus=0 “pending”
The daily emails may contain more information.

Q: Can we get back a token when using the check MICR?

A: Cardknox only returns tokens on check transactions where it contains the routing and account number. When only check images and MICR were submitted the token is not returned since they can’t be reused on subsequent transactions.

EBT Food Stamp

get
https://x1.cardknox.com/gateway
Sale
get
https://x1.cardknox.com/gateway
Credit
get
https://x1.cardknox.com/gateway
Balance
get
https://x1.cardknox.com/gateway
Voucher
Sale
Credit
Balance
Voucher
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtfs:sale",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE",
"xCustReceipt": "TRUE"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtfs:credit",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtfs:balance",
"xDUKPT": "3748276384717382:2dh2298h28dhf982f298g",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xIP": "1.1.1.1"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtfs:voucher",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xVoucherApproval": "123df1248f",
"xVoucherSerial": "123",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE"
}

EBT Cash Benefits

get
https://x1.cardknox.com/gateway
Sale
get
https://x1.cardknox.com/gateway
Cash
get
https://x1.cardknox.com/gateway
Balance
Sale
Cash
Balance
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtcb:sale"
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtcb:cash",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xInvoice": "123456A",
"xIP": "1.2.3.4",
"xAllowDuplicate": "TRUE"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtcb:balance"
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xIP": "1.2.3.4"
}

EBT Wic (eWic)

get
https://x1.cardknox.com/gateway
Sale
get
https://x1.cardknox.com/gateway
Balance
get
https://x1.cardknox.com/gateway
Void
Sale
Balance
Void
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtw:sale"
"xAmount": "35.00",
"x1UnitPrice": "3.50",
"x1Qty": "10",
"1Upc": "075457026002",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "11111",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtw:balance"
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433", "xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xIP": "1.2.3.4"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "ebtw.void",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xRefNum": "81726356",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xIP": "1.1.1.1"
}

Gift Card

get
https://x1.cardknox.com/gateway
Issue
get
https://x1.cardknox.com/gateway
Redeem
get
https://x1.cardknox.com/gateway
Balance
get
https://x1.cardknox.com/gateway
Activate
get
https://x1.cardknox.com/gateway
Deactivate
Issue
Redeem
Balance
Activate
Deactivate
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "gift:issue",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xExp": "12/25",
"xCVV": "945",
"xStreet": "123 Any Street Apt 4b Anytown, NY",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "12345",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "gift:redeem",
"xAmount": "35.00",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xExp": "12/25",
"xCVV": "945",
"xStreet": "123 Any Street Apt 4b Anytown, NY",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xTax": "2.00",
"xTip": "2.00",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "12345",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xAllowDuplicate": "TRUE"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "gift:balance",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xExp": "12/25",
"xCVV": "945",
"xStreet": "123 Any Street Apt 4b Anytown, NY",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xAuthCode": "T4321A",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xTax": "2.00",
"xTip": "2.00",
"xRefNum": "81234568",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "12345",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xMICR": "t021000021t 123456789o _2542",
"xRouting": "021202337",
"xGatewayRefNum": "852585258",
"xGatewayResult": "Approved",
"xGatewayError": "845455484",
"xGatewayCVV": "M",
"xGatewayAVS": "YYY",
"xOrderType": "Internet",
"xOrderID": "12356",
"xExistingCustomer": "TRUE",
"xOrderItems": "Sony Digital Camera",
"xCustomerComments": "Please ship as soon as possible",
"xShipMethod": "UPS Ground",
"xShipAmount": "29.99",
"xShipEmail": "[email protected]",
"xAllowDuplicate": "TRUE"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "gift:activate"
}
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "gift:deactivate"
}

Fraud

get
https://x1.cardknox.com/gateway
Fraud Submit
Fraud Submit
{
"xCardNum": "4444333322221111",
"xKey": "cardkexterdemodevedd527a2ece0472ab1dd853b3589",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "fraud:submit",
"xToken": "61h72mmh68phn9q233634ph3g54p1499m69qhp4816pn528h84",
"xCustom01": "Register01",
"xExp": "12/25",
"xCVV": "945",
"xStreet": "123 Any Street Apt 4b Anytown, NY",
"xZip": "12345",
"xMagstripe": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;4444333322221111=4912101123456789?",
"xName": "John Doe",
"xAuthCode": "T4321A",
"xDUKPT": "%B4444333322221111^TEST CARD/VISA^4912101123456789?;444433",
"xTax": "2.00",
"xTip": "2.00",
"xRefNum": "81234568",
"xInvoice": "123456A",
"xPONum": "123456B",
"xComments": "This is a comment",
"xDescription": "This is a description",
"xIP": "1.2.3.4",
"xEmail": "[email protected]",
"xFax": "1234567890",
"xBillFirstName": "John",
"xBillMiddleName": "Max",
"xBillLastName": "Doe",
"xBillCompany": "Acme",
"xBillStreet": "123 Any Street",
"xBillStreet2": "Apt 4b",
"xBillCity": "Anytown",
"xBillState": "NY",
"xBillZip": "12345",
"xBillCountry": "USA",
"xBillPhone": "8005551212",
"xBillMobile": "8005551111",
"xShipFirstName": "John",
"xShipMiddleName": "Max",
"xShipLastName": "Doe",
"xShipCompany": "Acme",
"xShipStreet": "123 Any Street",
"xShipStreet2": "Apt 4b",
"xShipCity": "Anytown",
"xShipState": "NY",
"xShipZip": "12345",
"xShipCountry": "USA",
"xShipPhone": "8005551212",
"xShipMobile": "8005551111",
"xMICR": "t021000021t 123456789o _2542",
"xRouting": "021202337",