EBTVoucherReturn Element

Namespace

http://Hps.Exchange.PosGateway

Type

PosEBTFSVoucherReturnReqType Complex Type

Diagram

Overview

EBTVoucherReturn PosEBTFSVoucherReturnReqType Complex Type

All

Block1 EBTFSVoucherReturnReqBlock1Type 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: Swipe is not allowed for a voucher purchase.

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

Note: For EBTVoucherPurchase transactions, a null expiration date is represented by setting the ExpMonth to 1 and the ExpYear to 9999 in the CardData.ManualEntry node.

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

The amount requested for authorization; this includes all other "Info" amounts provided as part of this request.

CardHolderData optional CardHolderDataType Complex Type

Card holder data

All

CardHolderFirstName optional firstNameType Simple Type

First name

CardHolderLastName optional lastNameType Simple Type

Last name

CardHolderAddr optional addrType Simple Type

Address

CardHolderCity optional cityType Simple Type

City

CardHolderState optional stateType Simple Type

State

CardHolderZip optional zipType Simple Type

Zip or postal code; see the associated Type pattern for restrictions.

Note: Canadian postal codes should be sent in the format "A0A0A0".

CardHolderPhone optional phoneType Simple Type

Phone number; see the associated Type pattern for restrictions.

CardHolderEmail optional emailType Simple Type

Email address

CardHolderLanguage optional languageIndicatorType Simple Type

CardHolder preferred language.

Note:This field is required for Canadian merchants.

AllowDup optional booleanType Simple Type

This is important in cases where the client processes a large number of similar transactions in a very short period of time; sending "Y" will skip duplicate checking on this transaction.

ElectronicVoucherSerialNbr Restriction of xs:string

Serial number from the EBT voice authorization system.

VoucherApprovalCd Restriction of xs:string

Approval code provided by the EBT voice authorization system

AdditionalTxnFields optional AdditionalTxnFieldsType Complex Type

A common group of optional fields that are supported in several different transaction types for Merchant use.

All

Description optional descriptionType Simple Type

Free-form description field. This must not contain sensitive information.

InvoiceNbr optional Restriction of xs:string

Used to log the invoice number on transactions that are not eCommerce.

CustomerID optional customerIDType Simple Type

Used to log Merchant specific customer identification.

Note: For GETI check transactions, this is sent in the CUSTOM3 field.

Source

<xs:element name="EBTVoucherReturn" type="PosEBTFSVoucherReturnReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema"></xs:element>