This page contains all API documentation for Electronic Benefit Transfer (EBT) transactions. For more information regarding account access, navigate to the Transaction API parent page.
The transactions below are not valid for EBT Online. To reference EBT Online, navigate to this page.
How to Generate Cardknox Keys
Sign in to the Cardknox Merchant Portal.
Select "Account Settings" from the navigation bar.
Select "Keys" from the sub-menu.
Click "Create a Key" in the top-right corner.
Choose the desired key type (API or iFields), description (software, etc.), and permissions.
Click "Create and View" and copy your key.
It is critical to copy your key and save it in a secure location, as you won’t be able to obtain the key again.
iFields and Transaction API
We recommend using iFields in conjunction with the Transaction API for added security. Cardknox iFields is an iFrames solution that keeps sensitive card data away from merchant servers while granting you complete control over form layout and design. 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 customize the page layout and design fully.
Endpoints
Health Check
HTTP Request Method: GET
Transactions
HTTP Request Method: POST
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:
Transactions
EBT Food Stamp
Sale
POSTebtfs:sale
xCommand = ebtfs:sale
The Sale command is used to make a purchase on an EBT cardholder’s food stamp account.
Request Body
{"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":"text@example.com","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"}
Credit
POSTebtfs:credit
xCommand = ebtfs:credit
The Credit command is used to credit an EBT cardholder’s food stamp account.
Request Body
Credit - Request Payload Example
{"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":"text@example.com","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"}
Balance
POSTebtfs:balance
xCommand = ebtfs:Balance
The Balance command is used to check the balance on an EBT cash benefit account.
xCommand = ebtfs:voucher
The Voucher command is used to process a manual EBT food stamp voucher.
Request Body
Voucher - Request Payload Example
{"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":"text@example.com","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
POSTebtcb:sale
xCommand = ebtcb:sale
The Sale command is used to make a purchase on an EBT cardholder’s cash benefit account.
Request Body
Sale - Request Payload Example
{"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":"text@example.com","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"}
Cash
POSTebtcb:cash
xCommand = ebtcb:Cash
The Cash command enables a cash withdrawal from an EBT cardholder’s cash benefit account.
xCommand = ebtw:sale
The Sale command is used to make a purchase on an EBTW cardholder’s cash benefit account.
Request Body
Sale - Request Payload Example
{ "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":"text@example.com","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"}
Balance
POSTebtw:balance
xCommand = ebtw:Balance
The Balance command is used to check the balance on an EBTW cash benefit account.