Links

Transaction API

Overview

The Cardknox API enables developers to process payments using the Cardknox gateway. Systems that integrate with the Cardknox API can submit API calls using various commands. The API supports many payment methods, including credit cards, ACH, EBT, and gift cards.
To begin building your API integration, click here to create an account for Cardknox sandbox — our secure testing environment that mimics the production environment. Upon signing up, you’ll 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.

iFields and Transaction API

We recommend using iFields in conjunction with the Transaction API for added security. Cardnox iFields is an iFrames solution that keeps sensitive card data away from merchant servers while granting you full control over form layout and design. Click here to learn more about iFields.
The Cardknox iFields solution utilizes iFrames in which the user enters their credit card and/or ACH information, and then uses JavaScript to generate SUTs (single-use tokens) for processing. These features allow the website to remain secure and out-of-scope for PCI compliance, while allowing the developer to fully customize the page layout and design.

Getting started

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.

Endpoints

Cardknox allows you to send the data in FormData, JSON, and XML formats.
Add to the base URL any of the following formats to indicate which format you are sending it as:
FormData
/gatewayform
https://x1.cardknox.com/gatewayform
JSON
/gatewayjson
https://x1.cardknox.com/gatewayjson
XML
/gatewayxml
https://x1.cardknox.com/gatewayxml

Request Method

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

Credit Card

post
cc:sale
Sale
post
cc:authonly
AuthOnly
post
cc:capture
Capture
post
cc:adjust
Adjust
post
cc:save
Save
post
cc:postauth
PostAuth
post
cc:credit
Credit
post
cc:refund
Refund
post
cc:voidrefund
VoidRefund
post
cc:voidrelease
VoidRelease
post
cc:void
Void

Check (ACH)

post
check:sale
Sale
post
check:credit
Credit
post
check:save
Save
post
check:void
Void
post
check:refund
Refund

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 the status. Via email, webhook, the Cardknox Portal, or by pulling a report using our reporting API.

Q: What verbiage comes back from the ACH Status?

A: You should get back the following status codes from Cardknox:
  • 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 that contain the routing and account number. In the event only check images and MICR were submitted, the token is not returned since it can’t be reused on subsequent transactions.

EBT Food Stamp

post
ebtfs:sale
Sale
post
ebtfs:credit
Credit
post
ebtfs:balance
Balance
post
ebtfs:voucher
Voucher

EBT Cash Benefits

post
ebtcb:sale
Sale
post
ebtcb:cash
Cash
post
ebtcb:balance
Balance

EBT Wic (eWic)

post
ebtw:sale
Sale
post
ebtw:balance
Balance
post
ebtw:void
Void

Gift Card

post
gift:issue
Issue
post
gift:redeem
Redeem
post
gift:balance
Balance
post
gift:activate
Activate
post
gift:deactivate
Deactivate

Fraud

post
fraud:submit
Fraud Submit

Request Payload Examples

Credit Card

Sale
AuthOnly
Capture
Adjust
Save
PostAuth
Credit
Refund
VoidRefund
Void Release
Void
{
"xCardNum": "4444333322221111",
"xExp": "1030",
"xKey": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:voidrefund",
"xCustom01": "Register01",
"xRefNum": "93827163"
}
{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:voidrelease",
"xCustom01": "Register01",
"xRefNum": "93827163"
}
{
"xKey": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "cc:sale",
"xCustom01": "Register01",
"xRefNum": "93827163"
}

Check (ACH)

Sale
Credit
Save
Void
Refund
{
"xKey": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"xVersion": "4.5.9",
"xSoftwareName": "YourSoftwareName",
"xSoftwareVersion": "1.0.0",
"xCommand": "check.void",
"xCustom01": "Register01",
"xRefNum": "81726356",
"xIP": "1.1.1.1"
}
{
"xKey": "[xkeycredentials]",
"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"

EBT Food Stamp

Sale
Credit
Balance
Voucher
{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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

Sale
Cash
Balance
{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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)

Sale
Balance
Void
{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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": "[xkeycredentials]",
"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

Issue
Redeem
Balance
Activate
Deactivate
{
"xCardNum": "4444333322221111",
"xKey": "[xkeycredentials]",
"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",