EBTBalanceInquiry Element

Description

EBTBalanceInquiry returns the available balance for an EBT account.

Namespace

http://Hps.Exchange.PosGateway

Type

PosEBTBalanceInquiryReqType Complex Type

Diagram

Overview

EBTBalanceInquiry PosEBTBalanceInquiryReqType Complex Type

EBTBalanceInquiry returns the available balance for an EBT account.

All

Block1 EBTBalanceInquiryReqBlock1Type Complex Type

Contains a series of required and optional elements

All

CardData CardDataType Complex Type

A common element used in several different transactions for supplying payment method information.

This includes a choice of typical payment representations like track data, manually entered data, and token information. It also includes options for specifying how the supplied data has been encrypted or to request a multi-use token be supplied in the response.

Note: Swiped EBT transactions require track 2 data. Manually entered account numbers can only be used in the following instances:

Track cannot be read
Card is not present
Reader is not available

Note: Multi-use and single-use tokens are not supported for EBT.

Sequence

Choice

TrackData CardDataTypeTrackData Complex Type

Track data is the full magnetic stripe data.

Note: TrackData is unique in that it has an attribute "method" that is used to indicate how the associated data was obtained.

ManualEntry

This is typically manually entered card data, but can be used in any case where only the card number is used rather than the full track.

TokenData

This is used when the card number from a previous transaction has been tokenized. This supports both multi-use and single-use tokens.

EncryptionData optional EncryptionDataType Complex Type

If the supplied card data was encrypted, this must be supplied.

TokenRequest optional booleanType Simple Type

This is used to request the gateway to return a multi-use token for the supplied card data. If a token is provided in the card data and this flag is set, it will be echoed in the response.

TokenParameters optional TokenParametersType Complex Type

Parameters allowing the client to control aspects of how a requested multi-use token is generated.

Not Applicable for Reward Cash transactions.

Amt amtTypeGlobal Simple Type

This is a legacy field that must now always be sent as $0.00.

PinBlock pinBlockType Simple Type

PIN block generated from the encrypted cardholder PIN and key serial number (KSN); see the guide for the specific PIN pad device being used to determine how to obtain the data elements required to create a PIN block.

Note: Portico requires the order of the data to be encrypted PIN followed by the KSN. If the encrypted PIN was 11111111 and the KSN was 22222222, the PIN block would have to be 1111111122222222 when sent to the gateway.

BalanceInquiryType EBTBalanceInquiryType Simple Type

Indicates the account type to inquire (i.e. cash benefits, food stamp); see the associated Type enumerations for specific values supported.

Source

<xs:element name="EBTBalanceInquiry" type="PosEBTBalanceInquiryReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">EBTBalanceInquiry returns the available balance for an EBT account.</p>
    </xs:documentation>
  </xs:annotation>
</xs:element>