Check an EBT Card Balance

In this article

Step 1: Register the POS command

Step 2: Add the amount tags to the POS menu

Step 3: Add the command to a POS button

POS card entries

A balance inquiry lets the cashier check the remaining balance on the customer's EBT card before payment. The inquiry sends a zero-amount request to the payment terminal, so nothing is charged to the card. The result is stored on the POS card entry and used to check that the card can cover the EBT amount. To use an inquiry at the POS, see Take an EBT Payment at the POS.

Step 1: Register the POS command

  1. Click the icon, enter POS External Commands, and select the relevant link.
  2. Choose Register, and in the Objects window enter 10044763 to find the codeunit, then register it. Two commands with POS module EBT are added to the list: EBT_BALANCE with description EBT Balance Inquiry, and EBT_BALANCE_DIALOG with description EBT Balance Inquiry with Dialog.

    Registered EBT balance inquiry POS command

Step 2: Add the amount tags to the POS menu

Add the EBT amount tags to the POS as described in EBT POS Menu Setup. The tags only show values when Enable Limitation is on.

EBT amount tags on the POS

Step 3: Add the command to a POS button

  1. Open the POS Menu that contains the button, and add a menu line (or edit an existing one).

  2. Set Command to EBT_BALANCE or EBT_BALANCE_DIALOG. Both commands run the same inquiry; they differ in what the cashier sees:

    • EBT_BALANCE runs the inquiry and records the balance without showing it. Use it to run the inquiry before the customer pays, so that the EBT amount check can use the result.

    • EBT_BALANCE_DIALOG runs the same inquiry and also shows the balance in a pop-up message, EBT balance: <amount>, once the terminal approves the inquiry.

  3. Set Parameter to the Tender Type Code of the EBT card tender type (or the EBT Cash tender type) created in Add EBT Tender Types to a Store. Use the same Parameter for both commands. The inquiry uses this code to find the store limitation and send the correct tender type to the PSP. Run the inquiry for each tender type before the customer pays with it; a balance inquiry made for one tender type is not used for the other.

    POS menu line for the EBT balance inquiry

Note: If Parameter is blank, the inquiry fails with the error Tender Type Code is required for EBT Balance Inquiry. If the code does not exist, it fails with Tender Type Code <code> is not found.

Note: If the terminal does not approve the inquiry (for example, it is declined, cancelled, or fails), both commands show the message from the terminal. If the terminal gives no message, the POS shows EBT balance inquiry was not approved. The inquiry is not recorded as an approved balance inquiry, and it does not start the recovery of a failed card payment the next time you tender with a card.

Use a balance inquiry on a sale with no lines

Both commands also work when the sale has no lines yet. In that case, the result is for display only and is not carried over to a later sale. When the sale already has lines, the EBT amount check uses an approved inquiry as described in Pay with EBT.

POS card entries

Each balance inquiry is logged as a POS card entry with the PSP's authorization details. Two EBT fields are available on the POS Card Entries page:

  • EBT Balance: the remaining balance of the EBT card returned by the PSP.
  • EBT Balance Inquiry: selected only when the inquiry was approved and the sale has lines.

POS Card Entries page

POS receipt

When the transaction has an EBT payment and Enable Limitation is on, the receipt prints the balance that remains after the sale: a line EBT Balance: if an EBT card payment was made, and a line EBT Cash Balance: if an EBT Cash payment was made. Each value is based on the balance inquiry made for that tender type.

Note: The balances are kept in memory for the session, so reprinting an older receipt shows the last stored balance. When both lines print, the values are not aligned.

POS receipt with EBT Balance line