EBT Online
EBT (Electronic Benefits Transfer) cards allow customers to pay for food and other products through government-funded financial assistance programs. One of the largest such programs is the Supplemental Nutrition Assistance Program (SNAP). SNAP is managed by the U.S. Department of Agriculture (USDA).
To qualify for SNAP EBT online processing, retailers must meet SNAP's food stocking requirements as well as their online purchasing requirements. One of the online purchasing requirements for retailers is to integrate their online shopping cart with a third-party processor that offers a digital PIN pad. Cardknox’s EBT solution utilizes a third-party PIN pad so that EBT cardholders can securely type in their PIN online just as they would in-store. Once the customer makes a payment with their EBT card, they are able to see the remaining balance on their card and complete the transaction.
During the implementation process, keep in mind that when submitting a sale transaction, you can add up to a 10% padding to the amount if the final price needs to be adjusted upon completing the order. When completing the order, the retailer would refund the remaining amount. Retailers must follow the refund process and not issue refunds using cash or gift cards.
The base URL to send transactions to is
https://x1.cardknox.comAdditionally, the backup URL is
https://b1.cardknox.com
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:
Format | Addtional URL | Full URL |
FormData | /gateway | https://x1.cardknox.com/gateway |
JSON | /gatewayjson | https://x1.cardknox.com/gatewayjson |
XML | /gatewayxml | https://x1.cardknox.com/gatewayxml |
As noted above, you can use “
https://b1.cardknox.com" as an alternative backup URL.Method: POST
Cardknox Gateway requires an HTTP POST method to be used for enhanced security.
We do not support the GET method.This API call will return the information needed to redirect the user to the PIN pad.
A PIN is needed for the
ebtonline:fssale, ebtonline:cbsale, and ebtonline:balance commands.Variable | Required | Description | Sample data |
xKey | Yes | Your Cardknox API Key. | [xkeycredentials] |
xVersion | Yes | Gateway API Version. The current version is 4.5.9 | 4.5.9 |
xSoftwareName | Yes | Name of your software. | [xsoftwarecredentials] |
xSoftwareVersion | Yes | Version number of your software. | [xversioncredentials] |
xCommand | Yes | Command specifying which transaction. | ebtonline:initiate |
xCardNum | Yes | The customer card number. Alternatively, xToken xMagStripe or SUT can be used. | 6004861944321111844 |
xShipMethod | Yes | Denotes Shipping Method | CustomerPickup |
Parameter Notes:
*This field can be sent either on the initiate transaction or follow up command transaction
**Required if xShipMethod is anything other than customer pickup
Process an EBT Online transaction to transfer funds from an EBT card to the retailer.
Variable | Required | Description | Sample data |
xKey | Yes | Your Cardknox API Key. | [xkeycredentials] |
xVersion | Yes | Gateway API Version. The current version is 4.5.9 | 4.5.9 |
xSoftwareName | Yes | Name of your software. | [xsoftwarecredentials] |
xSoftwareVersion | Yes | Version number of your software. | [xversioncredentials] |
xCommand | Yes | Command specifying which transaction. | ebtonline:fssale |
xAmount | Yes | The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction. | 9.99 |
xShipFirstName | Yes* | Customer’s first name for their shipping profile. | |
xShipMiddleName | Yes* | Customer’s middle name or initial for their shipping profile. | |
xShipLastName | Yes* | Customer’s last/family name for their shipping profile. | |
xShipCompany | Yes* | Customer’s company name for their shipping profile. | |
xShipPhone | No | Customer’s phone number for their shipping profile. | |
xShipMobile | No | Customer’s mobile number for their shipping profile. | |
xRefnum | Yes |
Parameter Notes:
*This field can be sent either on the initiate transaction or follow up command transaction
**Required if xShipMethod is anything other than customer pickup
Process an EBT Online cash benefits transaction to transfer funds from an EBT card to the retailer.
Variable | Required | Description | Sample data |
xKey | Yes | Your Cardknox API Key. | [xkeycredentials] |
xVersion | Yes | Gateway API Version. The current version is 4.5.9 | 4.5.9 |
xSoftwareName | Yes | Name of your software. | [xsoftwarecredentials] |
xSoftwareVersion | Yes | Version number of your software. | [xversioncredentials] |
xCommand | Yes | Command specifying which transaction. | cbsale |
xAmount | Yes | The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction. | 9.99 |
xShipFirstName | Yes* | Customer’s first name for their shipping profile. | |
xShipMiddleName | Yes* | Customer’s middle name or initial for their shipping profile. | |
xShipLastName | Yes* | Customer’s last/family name for their shipping profile. | |
xShipCompany | Yes* | Customer’s company name for their shipping profile. | |
xShipPhone | No | Customer’s phone number for their shipping profile. | |
xShipMobile | No | Customer’s mobile number for their shipping profile. | |
xRefnum | Yes | A unique request ID. | |
xShipMethod | Yes* | Shipping method. | Supported methods:
|
Parameter Notes:
*This field can be sent either on the initiate transaction or follow up command transaction
**Required if xShipMethod is anything other than customer pickup
Check the available balance on an EBT card
Variable | Required | Description | Sample data |
xKey | Yes | Your Cardknox API Key. | [xkeycredentials] |
xVersion | Yes | Gateway API Version. The current version is 4.5.9 | 4.5.9 |
xSoftwareName | Yes | Name of your software. | [xsoftwarecredentials] |
xSoftwareVersion | Yes | Version number of your software. | [xversioncredentials] |
xCommand | Yes | Command specifying which transaction. | balance |
xRefnum | Yes | A unique request ID. | |
xShipMethod | Yes* | Denotes Shipping Method | Supported methods:
|
Parameter Notes:
*This field can be sent either on the initiate transaction or follow up command transaction
**Required if xShipMethod is anything other than customer pickup
Process an EBT online refund transaction to return funds from the retailer to the cardholder.
Variable | Required | Description | Sample data |
xKey | Yes | Your Cardknox API Key. | [xkeycredentials] |
xVersion | Yes | Gateway API Version. The current version is 4.5.9 | 4.5.9 |
xSoftwareName | Yes | Name of your software. | [xsoftwarecredentials] |
xSoftwareVersion | Yes | Version number of your software. | [xversioncredentials] |
xCommand | Yes | Command specifying which transaction. | refund |
xAmount | No | The total amount of the transaction, inclusive of tax and tip if applicable. This the total amount of the transaction. | 9.99 |
xRefnum | Yes | A unique request ID. |
​
Process an EBT Online void transaction to cancel out a sale.
Variable | Required | Description | Sample data |
xKey | Yes | Your Cardknox API Key. | [xkeycredentials] |
xVersion | Yes | Gateway API Version. The current version is 4.5.9 | 4.5.9 |
xSoftwareName | Yes | Name of your software. | [xsoftwarecredentials] |
xSoftwareVersion | Yes | Version number of your software. | [xversioncredentials] |
xCommand | Yes | Command specifying which transaction. | void |
xRefnum | Yes | A unique request ID. |
Variable | Description | Sample data |
Variable | Description | Sample data |
xResult | Transaction status | A
D
E |
xDate | ||
xStatus | Result verbiage | Approved
Declined
Error |
xMaskedCardNumber | ||
xToken | ||
xError | Error message, if applicable | |
xRefnum | Cardknox reference number | |
xCardType | Type of card | EBT |
xPinPadURL | This field is returned on the initiate command and you would send it when redirecting to the PIN pad | |
xAccuID | This field is returned on the initiate command and you would send it when redirecting to the PIN pad | |
xRemainingBalanceEBTCB | Indicates the remaining EBT cash benefits balance | |
xRemainingBalanceEBTFS | Indicates the remaining EBT cash benefits balance | |
xBatch | Batch into which transaction will settle | |
xAuthAmount | The total amount authorized, inclusive | |
xEbtOnlineErrorMessage | Error message as received from the EBT online provider. | |
xEbtOnlineErrorCode | Error code as received from the EBT online provider. | |
xEbtOnlineResponseCode | Response code as received from the EBT online provider. |
Responses that can be returned.
Response Code | Response Message |
0 | ​ |
1 | Missing Parameter |
3 | Invalid Merchant/Terminal |
4 | Command Not Supported |
5 | Command Not Authorized |
6 | Decline |
12 | Invalid Transaction |
13 | Invalid Amount |
14 | The EBT card you entered is invalid. Please try again. |
23 | Unacceptable Transaction Fee |
40 | Request Not Supported |
41 | The EBT card you used is restricted and cannot be used. Please call the number on the back of your card for assistance or use a different payment method. |
42 | Invalid Account |
43 | The EBT card you used is restricted and cannot be used. Please call the number on the back of your card for assistance or use a different payment method. |
51 | Your SNAP (or Cash) payment failed for insufficient funds. |
54 | Expired Card |
55 | The PIN you entered is incorrect. Please re-enter your PIN. |
56 | The EBT card you entered is invalid. Please try again. |
57 | Your credit / debit card has been declined. Please try again or add a different payment method. |
59 | Your credit / debit card has been declined. Please try again or add a different payment method. |
60 | Card Acceptor Contact Acquirer |
61 | The refund amount requested exceeds the original sales amount. |
62 | The EBT card you used is restricted and cannot be used. Please call the number on the back of your card for assistance or use a different payment method. |
67 | Decline |
75 | Your card was locked after too many incorrect PIN attempts. Please call the number on the back of your card for assistance. |
76 | Key Synchronization Error |
89 | CVV Failed |
90 | No Account On File |
92 | There has been an error while processing your PIN. Please try again. |
96 | There has been an error while processing your PIN. Please try again. |
9 | There has been an error while processing your PIN. Please try again. |
Errors that can be returned.
Error Code | Error Message |
501 | Invalid IP Address |
502 | Invalid User Credentials |
503 | Request Validation Failed |
504 | Invalid Hash Value |
602 | Invalid User |
603 | Original Transaction Not Found |
604 | Payment provider could not read card. Please try again |
605 | Track Data Error |
607 | RSA Token Key Error |
608 | Tokenazation Error |
609 | Transaction Type can not be reversed |
610 | Invalid Currency |
611 | Invalid BIN |
612 | BIN Error |
616 | Merchant Descriptor Error |
618 | Our payment solution provider is not responding. Please try again. |
621 | Duplicate Reference Key |
622 | Transaction Type Not Supported |
702 | Error With Transaction Number |
703 | SAF Error |
704 | EFT Connection Error |
712 | Declined transaction |
713 | Our payment solution provider is not responding. Please try again. |
After the
ebtonline:initiate command, the Cardknox gateway will return the necessary pieces to render the PIN pad. The website will take care of redirecting the user to the PIN pad.
To render the PIN pad redirect the consumer to the xPinPadURL (PaySecure) using a POST with the following parameters. Once the consumer has completed entry of their PIN, PaySecure will redirect the consumer back to your site using the URL in the AccuReturnURL field. PaySecure will determine the viewport (desktop or mobile) and render the PIN pad in an adaptive manner, meaning there are distinct layouts based on screen size. PaySecure does not use responsive web design as it interferes with the PIN pad functionality.Endpoint:
xPinPadURL that was returned in the initiate commandMethod: URL Redirection
This endpoint can only be called from the browser.
Format: FormData
Variable | Description | Sample data |
AccuId | xAccuID that was returned in the initiate command | |
AccuReturnURL | Fully qualified retailer’s URL; PaySecure will use to redirect the user upon completion of the PIN pad. URL encoding required | |
AccuLanguage | Language in which the PIN pad will be displayed to the user | en-US (English)
es-MX (Spanish) |
[Client Echoed Fields] | You may pass additional form fields that will be passed back to your AccuReturnURL.
There are no restrictions on these fields, provided their names are not the same as the reserved PaySecure names. Many retailers utilize these fields to pass session IDs used to identify the user upon return to the AccuReturnURL. |
Variable | Description | Sample data |
AccuResponseCode | Response code from PaySecure indicating if the pin process was successful | Accu000 = PIN successfully collected
Accu200 = Cardholder pressed cancel button
Accu400 = Cardholder inactivity timeout
Accu600 = Invalid data received by terminal
Accu710 = Terminal security issue
Accu720 = Terminal communication issue
Accu730 = Terminal internal error
Accu800 = General error encountered |
AccuResponseMsg | Response message from PaySecure indicating if the pin process was successful | see AccuResponseCode |
AccuId | xAccuID that was submitted | |
[Client Echoed Fields] | Fields that you sent in the Redirect Parameters to the pin pad in [Client Echoed Fields] |
ebtonline:fssale, ebtonline:cbsale, and ebtonline:balance transactions require the user to enter a PIN during the transaction process (for ebtonline:refund and ebtonline:void skip to step 3). As per the EBT requirement (certification), The PIN is not sent with the transaction to the gateway, the Acculynk PIN pad must be used. Acculynk sends the PIN directly to PaySecure and it’s identified by a unique transaction ID.
The
ebtonline:initiate will begin the PIN process. Cardknox will return the necessary pieces to render a PIN pad for the user.Request
1
{
2
"xKey": "xxxxxxxxxxxxxxxxxxxxxxx",
3
"xVersion": "4.5.9",
4
"xSoftwareName": "YourSoftwareName",
5
"xSoftwareVersion": "1.0.0",
6
"xCommand": "ebtonline:initiate",
7
"xCardNum": "6004861944321111844",
8
"xShipMethod": "CustomerPickup"
9
}
Response
1
{
2
"xResult": "A",
3
"xStatus": "Approved",
4
"xError": "",
5
"xErrorCode": "00000",
6
"xRefNum": "600546727",
7
"xAvsResultCode": "",
8
"xAvsResult": "Unmapped AVS response",
9
"xCvvResultCode": "",
10
"xCvvResult": "No CVV data available",
11
"xMaskedCardNumber": "6xxxxxxxxxxxxxx1844",
12
"xCardType": "EBT",
13
"xToken": "hp6h31h29phnh6p48pm6024mp8278q96",
14
"xInternalID": "5c3d7ba7-80d4-4437-b4cb-c259cf0757c6",
15
"xPinPadURL": "https://test.paysecure.acculynk.net/PINpad",
16
"xAccuID": "ce8da934-fe7c-47f4-90bd-46fd0e3ff99e",
17
"xMID": "xxxxxxxxxxxTest",
18
"xDate": "3/1/2022 12:51:52 PM",
19
"xEntryMethod": "Keyed",
20
"xRemainingBalanceEBTCB": "0.00",
21
"xRemainingBalanceEBTFS": "0.00",
22
"xEbtOnlineErrorCode": "00",
23
"xEbtOnlineErrorMessage": "SUCCESS"
24
}
Redirect the user to the
xPinPadURL for the user to enter their pin.
Request
1
<form action="https://test.paysecure.acculynk.net/PINpad" method="post">
2
<label>AccuId:</label>
3
<input type="text" id="AccuId" name="AccuId" value="">
4
<label>AccuReturnURL:</label>
5
<input type="text" id="AccuReturnURL" name="AccuReturnURL" value="">
6
<label>AccuLanguage:</label>
7
<input type="text" id="AccuLanguage" name="AccuLanguage" value="en-US">
8
<input type="submit" value="Submit">
9
</form>
Response
1
AccuLanguage=en-US&
2
AccuId=ce8da934-fe7c-47f4-90bd-46fd0e3ff99e&
3
AccuResponseCode=ACCU000&
4
AccuResponseMsg=SUCCESS
Once the user is redirected back to your site with the response code
Accu000 submit the final request (ebtonline:fssale, ebtonline:cbsale, or ebtonline:balance) to the Cardknox gateway to complete the transaction. If you receive any other response code, allow the user to try again or cancel the transaction.
Request1
{
2
"xKey": "xxxxxxxxxxxxxxxxxxxxxxx",
3
"xVersion": "4.5.9",
4
"xSoftwareName": "YourSoftwareName",
5
"xSoftwareVersion": "1.0.0",
6
"xCommand": "ebtonline:fssale",
7
"xAmount": "1",
8
"xRefNum": "123456789"
9
}
Response
1
{
2
"xResult": "A",
3
"xStatus": "Approved",
4
"xError": "",
5
"xErrorCode": "00000",
6
"xRefNum": "600548315",
7
"xAuthCode": "452251",
8
"xBatch": "6329524",
9
"xAvsResultCode": "",
10
"xAvsResult": "Unmapped AVS response",
11
"xCvvResultCode": "",
12
"xCvvResult": "No CVV data available",
13
"xAuthAmount": "1.00",
14
"xMaskedCardNumber": "6xxxxxxxxxxxxxx1844",
15
"xCardType": "EBT",
16
"xMID": "xxxxxxxxxxxTest",
17
"xDate": "3/1/2022 12:54:39 PM",
18
"xEntryMethod": "Unknown",
19
"xRemainingBalanceEBTCB": "932.62",
20
"xRemainingBalanceEBTFS": "235.25",
21
"xEbtOnlineResponseCode": "00",
22
"xEbtOnlineErrorCode": "00",
23
"xEbtOnlineErrorMessage": "SUCCESS"
24
}
Test Card | Response Code | Error Message |
6004861944321111844 | 0 | (Approved) |
1 | Missing parameter | |
3 | Invalid merchant/terminal | |
6104341675219380 | 4 | Command not supported |
6104341397212234 | 5 | Command not authorized |
6104342085618120 | 6 | Decline |
6004861835913142835 | 41 | Decline |
6004861659118294500 | 43 | Decline |
6104341476018981 | 57 | Decline |
6004861674715978348 | 59 | Decline |
6004861469721133669 | 67 | Decline |
6104341094217098 | 12 | Invalid transaction |
6104341339116774 | 13 | Invalid amount |
6104342179210040 | 14 |