Attachment 10 WIC Interface Configurations.pdf

Attachment 10 – WIC MIS to eWIC Processor Interfaces

WIC MIS to EBT Interface Page 2

Online Shopping Vendor to EBT Interface Page 88

WIC MIS to EBT Interface

Table of Contents

1 Definitions and Acronyms

2 Introduction

2.1 Document Purpose

3 Interface Types

3.1 Message Based System Interfaces

3.1.1 Data Required in All Message Based System Interfaces

3.1.2 Message Processing Standards

3.2 Batch System Interfaces

3.2.1 Data Required in All Batch System Interfaces

3.2.2 Confirmation File Format

3.2.3 Batch Processing Standards

3.2.4 File Naming Standards

4 Interface

4.1 WIC EBA Account Maintenance

4.1.1 Add EBA

4.1.2 Update EBA

4.1.3 Get EBA Details

4.2 WIC EBA Benefit Maintenance

4.2.1 Add or Update Benefits

4.2.2 Get Benefit Balance

4.2.3 Get Benefit Maintenance History

4.2.4 Get Benefit Redemption History

4.3 Cardholder/Card Maintenance

4.3.1 Add Cardholder/Card

4.3.2 Add or Update PIN

4.3.3 Validate PIN

4.3.4 Update Card/Cardholder

4.3.5 Get Cardholders/Cards

4.3.6 Get Card History

4.3.7 Report Card Updates

4.4 Vendor Maintenance

4.4.1 Add or Update WIC Vendor File

4.5 WIC Food Maintenance

4.5.1 Add or Update Category/Sub-category Information

4.5.2 Add or Update UPC/PLU Information

4.6 WIC EBT Data Files

4.6.1 Report WIC Benefit Redemptions

4.6.2 Report WIC Benefit Changes

4.6.3 Report WIC Benefits Purged

4.7 Financial Settlement

4.7.1 Request ACH Payment

4.7.2 Report ACH Payments

4.8 Recoupment Files

4.8.1 Report Recoupment Requests

4.8.2 Report Recoupment Status

4.9 Warehouse Authorization

4.9.1 Request Warehouse Authorization

4.9.2 Void Warehouse Authorization

4.9.3 Get Warehouse Authorizations

4.9.4 Get Warehouse Authorization Code

Appendix A - Data Dictionary

Appendix B - Data Element Code Tables

B.1 Action Code

B.2 Function Return Code

B.3 Hierarchy Code

B.4 Language Code

B.5 PIN Activity Code

B.6 Reason Code

B.7 Status Code

B.8 Type Code

B.9 Message Type

B.10 File Type

B.11 ICD Version

B.12 WIC EBT System ID

B.13 WIC MIS System ID

B.14 POS Data Code

Appendix C - Common Objects

C.1 Cardholder Object

C.2 Person Object

C.3 Address Object

C.4 Head of Household Object

1 Definitions and Acronyms Acronym or Term Definition ACH Automated Clearing House. An electronic network for financial transactions in the

United States.

Adjustment A special transaction that modifies benefits or payment amounts in relation to a previous transaction that was either processed in error or processed in a manner deemed to be “unfair” to one party in the transaction.

APL Authorized Product List. A listing of approved products provided to retailers by WIC authorities.

BDK Base Derivation Key. A static key stored on a PIN pad device, which is used to derive unique keys for encrypting data.

Benefit A product provided by the WIC State Agency to a WIC participant. For the purposes of this system, a WIC benefit is an authorized food product.

Benefit Period A time period during which WIC benefits may be redeemed. This includes the beginning benefit availability and ending benefit availability dates.

BIN Bank Identification Number (also known as IIN). It identifies the major industry (e.g., finance or banking) and the card issuer.

BKLK Base Key Loading Key. A key used to encrypt keys stored on a PIN pad device.

Broadband Subcategory This is subcategory 000. UPCs can be specified under the broadband subcategory only, a specific subcategory (subcategory greater than 000), or under both the broadband subcategory and one specific subcategory. This allows the WIC State Agency to issue specific food items via a specific subcategory to a participant in a food prescription. Another participant’s nutritional needs may allow a greater choice of food items within a category (e.g., milk). In this case, this food prescription issuance is made via the broadband subcategory. Since a household’s food benefits are aggregated on the card, in some cases UPCs may be redeemed via both the broadband and specific subcategories.

Card Acceptor Terminal A number that uniquely identifies a card terminal (i.e., the POS device in the store).

Cardholder The individual who is in possession of the WIC EBT card for a household.

Category A grouping of WIC authorized food products, such as milk or formula CMS Clinic Management System. CDP’s WIC certification and management information system.

CVB Cash Value Benefit Discount A reduction in the total redemption transaction amount due to a coupon and/or store promotion.

DUKPT Derived Unique Key Per Transaction EBA Electronic Benefit Account EBT, eWIC Electronic Benefits Transfer. The electronic transfer of government benefits to individuals through the use of card technology and point-of-sale terminals.

Exchange Size The amount that is decremented from a balance upon the purchase of a product.

Expungement Period The number of days after which an unused benefit is removed.

FMNP Farmers Market Nutrition Program FNS Food and Nutrition Service Generator Date Begin/End A date range applied to the date/time assigned by the message initiator, such as a specific retailer.

HGTN Host Generated Trace Number. The unique trace number assigned to a transaction by the host server.

IIN Issuer Identification Number. A six digit number that is unique to a single card issuer.

IVR Interactive Voice Response. An automated phone system that allows WIC participants to obtain current account and benefit information.

KSI Key Set Identifier. The first N digits of the KSN.

KSN Key Serial Number. A number stored on a PIN pad device that is incremented each time a PIN is entered. The KSN and BDK together are used to derive a key that is used to encrypt a PIN.

Merchant See Retailer MIS Management Information System. A state’s WIC certification and management information system.

NTE Not to Exceed Price. WIC authorities establish the maximum price that the state will reimburse for an approved WIC item.

PAN Personal Account Number. The PAN is a 16-19 digit numeric field that provides the means of identifying the issuing state and the recipient to whom the card was issued.

Participant The individual to whom WIC benefits are issued.

PIN Personal Identification Number. An alphanumeric code issued to or selected by a cardholder, which must be utilized by the cardholder in conjunction with a card to initiate a transaction.

PLU Price Look-Up Code. A store-assigned numeric designation for products that are typically of variable measure (e.g., meat, seafood, fruits, grains).

POS Point of Sale. An electronic device used by retail businesses to process credit and debit transactions.

Receiver The entity that receives a file or transaction request.

Retailer A dealer in foodstuffs, meats, produce, and dairy products. In the context of this document, the term also covers any parties authorized by the state to be a vendor of WIC-approved items, or who perform WIC-related computing or financial transactions for them.

S&F Store and Forward. The process by which a WIC retail transaction is stored during a system disruption, and then forwarded to the EBT host when service is restored.

SOAP Simple Object Access Protocol. A protocol standard used for exchanging information in computer networks.

STAN System Trace Audit Number. A number assigned by the message initiator to uniquely identify a transaction.

Subcategory A specific type of authorized food product within a WIC category. For example, subcategories for milk include whole milk and skim milk. Subcategories can be either broadband (code 000) or specific (codes greater than 000).

Transaction Any event that effects change to the WIC Direct database. This includes participant balance inquiries and WIC redemptions.

Transaction Time The date and time when the transaction occurred.

UI User Interface Unit of Measure The measurements used for WIC-approved products that are stored in WIC Direct.

UPC Universal Product Code. The code used to identify retail items, including WIC-approved items. It is represented by a bar code.

USDA United States Department of Agriculture Vendor See Retailer WIC Women, Infants, and Children. A special supplemental nutrition program for

Women, Infants, and Children.

WIC State Agency A governmental organization that oversees the WIC program for a jurisdiction, such as a state or tribal organization. A WIC Authority is responsible for issuing WIC food benefits.

WIC-allowable, WIC-eligible

An FNS designation. A WIC-allowable or WIC-eligible food item meets federal WIC dietary and nutritional standards and guidelines.

WIC-approved, WIC-authorized

A WIC State Agency designation. A WIC-approved or WIC-authorized food item is an item identified as WIC-allowable or WIC-eligible by FNS and approved or authorized by the WIC State Agency for purchase with WIC benefits.

WIC Host An information system that manages data exchange between a retailer and a WIC State Agency. The WIC host includes communication, database, file posting, security authorization, and may include terminal application downloads. Electronically, it acts as a proxy for a WIC State Agency in the processing of WIC EBT benefits and redemptions.

WSDL Web Service Definition Language. A format used to describe the specific layout of messages using SOAP.

WUMEI WIC Universal MIS to EBT Interface X9.93 The standard that defines the message and file formats used in performing WIC EBT transactions.

XML Extensible Markup Language XSD XML Schema Definition

2 Introduction

2.1 Document Purpose

This document describes WIC Direct’s implementation of the Universal Interface between the WIC Management Information Systems (WIC MIS) and WIC Direct. The interface is based upon the WIC Universal MIS – EBT Interface - Functional Requirements – Version 3 November 2014 (WUMEI) document, the Technical Implementation Guide (TIG), and related bulletins which are available from the USDA-FNS.

The document defines and describes those interfaces currently supported by WIC Direct. It provides a description of:

The types of interfaces between the WIC MIS and WIC Direct.

The functions supported by WIC Direct.

The core data elements required by the defined functions.

The processing rules to be implemented to support the functions.

3 Interface Types When first implementing a WIC EBT system or when replacing a WIC EBT system, a WIC State Agency chooses a system based on an analysis of the functions and types of interfaces offered that best work within the capabilities of its WIC MIS environment. The types of WIC EBT and WIC MIS interfaces described in this document are:

Message Based System interface – the systems exchange messages to perform the function.

Message based system interfaces are used for performing real time transfers of data between The WIC MIS and WIC EBT systems.

Batch System interface – the systems exchange batches containing data to perform the function.

The message based system interface and batch system interface types may be used independently or in combination depending on the needs and preferences of the MIS developer. The following sections describe each type of interface and the common data elements for each type of interface.

Throughout the document, data elements used in a specific function are listed in alphabetic order.

The common data elements are defined in Appendix A - Data Dictionary. The condition codes used in the data element tables shown in each function are:

Condition Code Description M (Mandatory) – Indicates that a data element is mandatory in both directions of the interface and may not be NULL.

ME (Mandatory Echo) – Indicates that a data element is required to be echoed from the previous message(s).

C (Conditional) – Indicates that if the condition identified applies, then the data element shall be present, otherwise its inclusion is subject to bilateral agreement. If a data element is not present, the default value indicated shall be used with fixed length data elements to fill the position for the data element. For alphanumeric and alpha data elements, the default values shall be spaces, unless otherwise indicated.

For numeric data elements, the default value shall be zeroes, unless otherwise noted.

CE (Conditional Echo) – Indicates that if the data element was supplied in the request message, then the data element is echoed in the response message.

O (Optional) – Indicates that a data element is optional and may be NULL. For update functions, if the field has an existing value and that value is to be preserved, then the existing value shall be supplied as a data element in the update function. A value of null will cause the existing value to be overwritten with null. The use of data elements indicated as optional shall be decided by bilateral agreement.

N/A (Not applicable) – Indicates that the data is not currently implemented and will be

NULL.

3.1 Message Based System Interfaces

WIC regulations require “same day service” for WIC Participants which means that once notice of certification is provided, the WIC Participant may leave the clinic with benefits and shop at an authorized WIC Vendor location. Consequently, many of the functions performed between the

WIC MIS and the WIC EBT systems, such as account set up or benefit issuance, require a real time, message based system interface. A requirement for the Universal Interface is to make access to WIC EBT functions seamless to a user in the WIC clinic and to allow the use of the WIC EBT system to be driven by the WIC MIS user.

Some MIS designs permit remote or disconnected clinic operations. These MIS may still use a message based interface although some functions may not be fully completed until the MIS is connected to the WIC EBT or WIC State Agency system.

Message based system interfaces shall have the WIC MIS invoke WIC EBT functions by sending a message to the WIC EBT system. The WIC MIS provides the user interface, when appropriate, that either gathers the data necessary to execute a WIC EBT function or presents the results of a WIC EBT query to the clinic user. The response in a message based interface may be one or more messages providing the requested data.

WIC Direct supports a web service implementation of this ICD using Simple Object Access Protocol (SOAP). The WIC Direct team will provide access to end point that implements this ICD using a SOAP interface. The end point will access a Web Service Definition Language (WSDL) file that defines the specific implementation of the messages in this ICD as SOAP messages.

3.1.1 Data Required in All Message Based System Interfaces

The following list of data elements and their associated condition codes (CC’s) will be included in both directions of the messages exchanged in a message based system interface. See Appendix A

- Data Dictionary for definitions. This record shall appear as a Message Header Object.

Data element name

Condition sending

Condition responding

Usage Notes

Clinic ID O CE If provided, this is the ID of the clinic that initiates the request (rather than the ID of the clinic to which the household belongs)

Date and time, transmission

M ME

Function return code

N/A M May be used to explicitly indicate that a message was received and the result of processing the message; See Appendix B.2 for values

Initiating user ID O CE Local agency ID O CE If provided, this is the ID of the local agency that initiates the request (rather than the ID of the local agency to which the household belongs)

Message type M ME Message type, see Appendix B.8.1 ICD message version M ME ICD version, see Appendix B.11 Password M ME Unique EBT transaction identifier

M ME This value must be unique in every request that updates or adds data and shall not be repeated.

Uniqueness is not enforced for read operations. If a request is declined, then a new value must be supplied on resubmission.

Data element name

Condition sending

Condition responding

Usage Notes

Username O CE WIC EBT system ID M ME See Appendix B.12 WIC MIS system ID M ME See Appendix B.13 WIC state agency ID M ME Workstation ID C CE Mandatory if Clinic ID present and nonzero

3.1.2 Message Processing Standards

The following processing standards shall be applied to processing done with a message system interface.

Rule ID Description

3.1.2.1 The WIC EBT system and the WIC MIS shall maintain the necessary computer hardware and software to interface directly with data processing facilities required to accommodate message based system interfaces.

3.1.2.2 All message based system interface messages shall be processed and responded to within 20 seconds.

3.1.2.3 If the condition specified for a data element is not met, the data element may be omitted from the message.

3.1.2.4 The receiver shall validate uniqueness of the Unique EBT transaction identifier from a given originator.

3.1.2.5 The receiver shall validate the WIC MIS system ID and Password combination is valid.

3.1.2.6 If a data is shown as optional, the sender may or may not provide the data element at their discretion.

3.2 Batch System Interfaces

A batch system interface is used for the transfer of bulk data between the WIC MIS and WIC EBT system and to synchronize data stored in separate locations. This may be a two-way data flow, with some of the transfers being initiated by the WIC MIS and others by the WIC EBT system.

Use of this form of system interface is left to the WIC State Agency and the MIS developer and depends upon where certain WIC EBT related functions have been implemented. In some instances, a message based system interface may be used instead of, or in addition to, a batch system interface.

WIC Direct supports an Extensible Markup Language (XML) implementation for files defined in this ICD. The WIC Direct team will provide an XML Schema Definition (XSD) that defines the specific implementation of the files in this ICD as XML files.

3.2.1 Data Required in All Batch System Interfaces

The following list of data elements and their associated condition codes (CC’s) shall be included in all files exchanged. See Appendix A - Data Dictionary for definitions. The object name is BatchFileHeader.

Data element name Condition Usage Notes Count, detail records M Date and time, transmission

M File create date and time

File type M Code identifying the type of file see Appendix B.10; used in lieu of File name field from WUMEI

File sequence number M WIC Direct will validate that the sequence number is unique for the given File Type and Originator of file. An error returned if a duplicate number is received for a previous file that was not entirely rejected.

ICD version M ICD version, see Appendix B.11 Originator of file M Sender of file (WIC EBT system ID or WIC MIS System ID) Receiving institution M Receiver of file (WIC EBT system ID or WIC MIS System ID) Type Code M Type code, see Appendix B.8; always use “U” for Update file WIC state agency ID M

The following is a list of data elements that will appear in every detail record in a batch file. The elements will be packaged into a DetailRecordHeader object:

Data element name Condition Usage Notes Record sequence number M A Record sequence number shall appear as a mandatory data element in each detail record included in the batch file.

Username O Mandatory if record was created as the result of an action by a user.

Workstation ID O

3.2.2 Confirmation File Format

All batch files should be acknowledged with a batch confirmation file. The batch confirmation file will include header followed by detail records of erroneous records (if any) from the original file. A file with no errors is acknowledged by a confirmation file with only a header.

The following is a list of data elements included in the header record for a confirmation file. The object name is BatchConfirmationFileHeader.

Data element name Condition Usage Notes Count, detail records M Echoed from original file Date and time, transmission

M File create date and time

File type M Echoed from original file File sequence number M Echoed from original file ICD version M ICD version, see Appendix B.11 Originator of file M Sender of file (WIC EBT system ID or WIC MIS System ID) Receiving institution M Receiver of file (WIC EBT system ID or WIC MIS System ID) Rejected row count M Number of rows rejected from original file Type Code M Echoed from original file WIC state agency ID M

The following is a list of data elements included in the detail records for a confirmation file. The object name is BatchConfirmationRejectedDetail.

Function return code M See B.2 for values Original line number M The line number from the original file with an error. Each line in a file is terminated with a “CR” and/or “LF” character.

Record sequence number M The record sequence number of the record from the original file with an error

3.2.3 Batch Processing Standards

The following processing standards shall be applied to processing done with a batch system interface.

Rule ID Description

3.2.3.1 A confirmation shall be provided to the sending party that the file was received for the files listed. The confirmation may take the form of a return file.

3.2.3.2 Batch level errors (e.g. wrong record count, etc.) shall be reported to the sending party in a confirmation file.

3.2.3.3 Detail record errors (e.g. provide specific record identifier and indication of specific error) shall be reported to the sending party in a confirmation file.

3.2.3.4 Batches may be transmitted on an as needed or periodic basis e.g., daily or monthly.

3.2.3.5 A batch with a header and no detail records shall indicate that no action is to be taken by the receiving system.

3.2.3.6 If the condition specified for a data element is not met, the data element may be defaulted to NULL or the default value indicated in the Data Dictionary.

3.2.3.7 For files consumed by WIC Direct, WIC Direct will create a confirmation file within five (5) minutes of receiving the original file.

3.2.4 File Naming Standards

All files shall be named according to the following convention: [YYMMDDHHMMSS].<File Extension> where [YYMMDDHHMMSS] corresponds to the date and time that originator creates the <File Extension> is the unique file extension assigned to the type of file being created. See Appendix B.10 for a listing of file types and the associated extensions.

Confirmation files shall be the name of the original file with “.c” included after the [YYMMDDHHMMSS] element.

All files incoming to WIC Direct (including confirmation files) may also be individually zipped if desired in order to reduce bandwidth usage and transfer times. The content of the zip file archives shall contain only one file and shall also not have any additional folder structure. The zip files themselves shall be named according to the conventions above with “.zip” appended to the end of the file name, and the file within the archive shall be named according to the conventions above.

4 Interface This section describes each functional area and their related functions. Each description of a functional area is organized as follows:

1. Description – Describes the functional area.

2. Functions – A table listing the functions implemented for the functional area, whether the function is required or optional in an implementation, the system interface type used for that function and the party responsible for originating the function.

The function table is followed by subsections for each function organized as follows:

1. Description - There is a brief description of the function.

2. Data elements - There is a table of input data elements for the function. The table only covers the core data elements needed for the specific function. The table contains the following columns:

a. Data element name – Name of the data element as it appears in the Data Element Dictionary.

b. Data element condition code (“Condition”) – Indicates whether the data element is Mandatory (M), Conditional (C) or Optional (O)

c. Usage notes – Explains the condition or requirements of data element usage.

3. Processing Rules – Any processing rules governing the function are listed.

4.1 WIC EBA Account Maintenance

The WIC EBA Account Maintenance functional area comprises functions for maintaining an Electronic Benefit Account (EBA) in WIC Direct. An EBA is account data maintained either on the WIC EBT host (WIC Online EBT) or on the chip in the Smart Card (WIC Smart Card EBT) in combination with data maintained at the WIC EBT system (WIC Smart Card EBT). The EBA is linked to an account on the WIC MIS using the WIC MIS account (MSA) ID. An EBA ties together all of the various data elements required to enable WIC EBT for a WIC account, such as benefit information, card data and transaction history. The EBA is updated when card information is changed, such as when a card is replaced.

4.1.1 Add EBA

The Add EBA function is a required function that uses a message based system interface to establish an EBA in the WIC EBT System and link the EBA to a WIC account from the WIC MIS. To establish an EBA account, only the WIC MIS account ID is required. The WIC EBT System expects that the WIC MIS shall perform any necessary checks for dual participation. The addition of cards and cardholders is described in 4.3.1. The following table lists the data elements sent for the Add EBA function:

Data element name Condition Usage Notes Head of household object C See Appendix C.4. Required if the State Agency is configured for IVR – household zip (see Appendix D -Configurability).

Reason code O Default to “E001 – new”; see Appendix B.6 for values.

Type code M WIC MIS account type (Household, Emergency Disaster, Compliance buy, Vendor), see Appendix B.8 for values WIC MIS account ID M

The following table lists the processing rules for the Add EBA function:

Rule ID Description

4.1.1.1 Validate that the WIC MIS account ID does not already exist for calling WIC State

Agency (not necessarily applicable for WIC Smart Card EBT system).

4.1.1.2 The Type code assigned when adding an EBA cannot be changed. The account must be deactivated and a new EBT account established.

The following table lists the processing rules specific to Reason code and Status code:

Reason code (send)

Status code (result)

Notes

Any valid value A001 (Activated)

The Reason code is validated but not recorded or used in any processing.

4.1.2 Update EBA

The Update EBA function is a required function that uses a message based system interface to change the head of household date of birth, name, or address that is held in the WIC EBT database and/or to update an EBA with a new WIC MIS account ID. It is also used to change the status of an EBA by deactivating or reactivating or placing on hold an EBA in the WIC EBT system as indicated by the Action code. The WIC MIS account Type code for an EBA should not be changed using this function; instead the account should be deactivated and a new one with the correct type established. It is recommended that WIC MIS support unique WIC MIS account IDs statewide. The following table lists the data elements sent for the Update EBA function:

Data element name Condition Usage Notes Action code M Update, Deactivate, Hold, etc. See Appendix B.1 for values Date, effective O While WIC Direct will accept this data element, the requested action is still effective immediately. WIC Direct does not honor the future data on a requested action.

Head of household object C See Appendix C.4. Required if the State Agency is configured for IVR – household zip (see Appendix D -Configurability).

Reason code O See B.6 for values.

WIC MIS account ID M WIC MIS account ID, new O If present, this WIC MIS account ID will be associated to the

EBA and the old WIC MIS account ID will be deactivated.

The following data elements are returned for the Update EBA function:

Data element name Condition Usage Notes Status code M Indicates result, Activated, Deactivated, etc. See Appendix B.7 for values

The following table lists the processing rules for the Update EBA function:

Rule ID Description

4.1.2.1 Validate that the (OLD) WIC MIS account ID exists.

4.1.2.2 If a (NEW) WIC MIS account ID is provided, then the WIC EBT System shall validate that the WIC MIS account ID, new does not already exist.

4.1.2.3 If a WIC MIS account ID, new is provided, then the WIC EBT System shall deactivate the (OLD) WIC MIS account ID.

4.1.2.4 If the WIC MIS account ID is deactivated, the WIC EBT System shall purge the remaining benefits when they expire.

The following table lists the processing rules specific to Action code, Reason code, and Status code:

Action code (send)

Reason code (send)

Status code (result)

Notes

001 (Activate) N/A N/A Not allowed 002 (Update) 005 (Reactivate)

Any valid value

A001 (Activated)

An Action code of 002 or 005 causes the EBA Status Code to be set to A001. The Reason code is validated but not recorded or used in any processing.

003 (Deactivate) 006 (Hold)

Any valid value

A002 (Deactivated)

An Action code of 003 or 006 causes the EBA Status Code to be set to A002. The Reason code is validated but not recorded or used in any processing.

4.1.3 Get EBA Details

The Get EBA Details function is a required function that uses a message based system interface to return detailed information on the EBA. This function allows a WIC MIS user the ability to have EBA information displayed via a WIC MIS screen. The WIC EBT System shall identify the EBA and return the household data information available.

The following table lists the data elements sent for the Get EBA Details function:

Data element name Condition Usage Notes Type code O WIC MIS Account type, default “Household”, see Appendix B.8 for other values WIC MIS account ID M

The following data elements are returned for the Get EBA Details function:

Data element name Condition Usage Notes Head of household object C Mandatory if provided when the EBA was added or updated

(See Appendix C.4) Status code M Status code assigned when EBA was last updated, see

Appendix B.7 for values Type code M Type code assigned when EBA was added, see Appendix B.8 for values WIC MIS account ID M

The following table lists the processing rules for the Get EBA function:

0.1 Validate that the WIC MIS account ID exists.

4.2 WIC EBA Benefit Maintenance

The WIC EBA Benefit Maintenance functional area comprises functions for maintaining and querying benefit information associated with the EBAs in the WIC EBT System.

4.2.1 Add or Update Benefits

The Add or Update Benefits function is a required function that uses a message based system interface to add (issue) or subtract (void) a Benefit quantity from an EBA. Issuing benefits results in an addition (credit) to the WIC Cardholder’s benefits; voiding benefits results in a subtraction (debit). Current and future benefits may be issued, voided or placed on hold by using the Date, begin benefit and Date, end benefit data elements in this function.

A unique Benefit issuance ID is assigned to benefits at the WIC MIS account ID level when issued.

The following table lists the data elements sent for the Add or Update Benefits function:

Data element name Condition Usage Notes Action code M Issue (add) or Void (subtract); see Appendix B.1 for values. WIC

Direct currently does not support placing benefits on Hold.

Card number O WIC MIS account ID M Reason code O New, Request, Withdrawal, etc. See Appendix B.6 for values A list of the following elements may appear:

Benefit issuance ID C Required if the transaction is an Issue (add). Assigned by the

MIS system.

Date, begin benefit C Required if the transaction is an Issue (add).

Date, end benefit M A list of the following elements are repeated for each Benefit issuance ID:

Benefit quantity M Category code M Category long description O Sub-Category code M Sub-Category long description

O

The following table lists the processing rules for the Add or Update Benefits function:

Rule ID Description

4.2.1.1 Validate that the WIC MIS account ID exists and is active.

4.2.1.2 Validate that the combination of Category code and Sub-Category code is valid for the

WIC State Agency.

4.2.1.3 The WIC MIS shall perform a balance inquiry before updating benefits.

4.2.1.4 If the transaction is a subtraction (void): a) Date, end benefit shall exactly match the

Date, end benefit for the benefits to be debited or the transaction is rejected; b) if the optional Benefit issuance ID and/or Date, begin benefit is provided then these field values shall exactly match the Benefit issuance ID and/or Date, begin benefit for the benefits to be debited or the transaction is rejected.

4.2.1.5 If the transaction is a subtraction (void), then the WIC EBT System shall only perform the subtraction if there is sufficient balance to post the entire subtraction. Partial approvals of void requests are not allowed.

4.2.1.6 If the transaction is an addition (issue), then there shall be a validation that the total Benefit quantity (units) available for the Category code and Sub-Category code on a given date shall not exceed the maximum balance (999.99).

4.2.1.7 Validate that EBA exists and is active

4.2.1.8 If the transaction is a subtraction (void) (where the optional Date, begin benefits is not provided) that spans multiple benefits with staggered Date, begin benefits, then the WIC EBT processor shall order the debit such that benefits with later Date, begin benefits are debited prior to benefits with earlier Date, begin benefits.

4.2.1.9 If the transaction is an addition (issue) and the State Agency is configured for Enforce unique benefit issuance ID, then WIC Direct will reject the addition if the Benefit issuance ID has already been used with a previous approved addition.

4.2.2 Get Benefit Balance

The Get Benefit Balance function is a required function that uses a message based system interface to retrieve benefit information for a particular EBA. This function allows the WIC MIS to retrieve from the WIC EBT system the remaining balance for the EBA and display it via the WIC MIS.

The following table lists the data elements sent for the Get Benefit Balance function:

Data element name Condition Usage Notes Benefit issuance ID C Mandatory if a specific remaining balance in a specific Benefit issuance ID is requested. Send “999,999,999,999” to request a balance broken down across all Benefit issuance IDs where benefits match the requested date range.

Card number C Mandatory if WIC MIS account ID not present Date, begin request O See 4.2.2.2 Date, end request O See 4.2.2.2 WIC MIS account ID C Mandatory if Card number not present

The following data elements are returned for the Get Benefit balance function:

Data element name Condition Usage Notes Card number CE WIC MIS account ID CE Also, if the Card number was sent in the request and there is balance data to return, then the WIC MIS account ID is also returned.

The following data is repeated for each Benefit issuance ID or date range:

Benefit issuance ID C Mandatory if requested Date, begin benefit M Date, end benefit M The following data is repeated for each Category code and Sub-Category code:

Benefit quantity, active hold

M

Benefit quantity, available M Depleted benefits (i.e. items with Benefit quantity available = 0) are returned Category code M Sub-Category code M

The following table lists the processing rules for the Get Benefit Balance function:

Rule ID Description

4.2.2.1 Validate that the WIC MIS account ID exists.

4.2.2.2 If Date, begin request, Date, end request and Benefit issuance ID are not provided, then the WIC EBT System shall only return records where the current date is between the Date, begin benefit and Date, end benefit.

4.2.2.3 The Category code long description, Category code short description, Sub-Category code long description and Sub-Category code short description data shall be maintained in the MIS and EBT system.

4.2.3 Get Benefit Maintenance History

The Get Benefit Maintenance History function is a required function that uses a message based system interface to retrieve benefit maintenance transaction data for a particular EBA. This function allows the WIC MIS to retrieve from the WIC EBT system the benefit maintenance transaction history for a given period for the EBA and display it via the WIC MIS. This function may also be used by the WIC EBT system to retrieve information from the WIC MIS. Any filter parameter values sent with this function will result in the return values being filtered to just those items that match. All benefit additions, voids, and purges may be retrieved using this function. The retention period for benefit data shall be defined by bilateral agreement.

The following table lists the data elements sent for the Get Benefit Maintenance History function:

Data element name Condition Usage Notes Card number C Mandatory if WIC MIS account ID not present Date, begin request M Date, end request M Type code O Used to request specific types of maintenance (Add, Void, Purged), see Appendix B.8 for values WIC MIS account ID C Mandatory if Card number not present

The following data elements are returned for the Get Benefit Maintenance History function:

Data element name Condition Usage Notes Action code C Add or subtract; see Appendix B.1 for values, echoed from the original message if the benefit update was initiated by the MIS using Add or Update Benefits (purges are not typically MIS initiated)

Card number C Echoed from original message if present Clinic ID C Echoed from original message if present Date and time, transmission (host)

M

Initiating user ID C Echoed from original message if present

Local agency ID C Echoed from original message if present Reason code C Echoed from original message if present Type code M Valid types are:

E - Expunged/expired I – Issuance/Add D – Void/Subtract

Unique EBT transaction identifier

M

Username N/A WIC MIS account ID M Workstation ID C Echoed from original message if present Multiple months’ benefits may be added/voided for each WIC MIS account ID and/or Card number. The object name is UniqueIssuanceObject.

Benefit issuance ID M Date, begin benefit M Date, end benefit M A list of the following elements are repeated for each Benefit issuance ID. The object name is UniqueIssuanceObjectDetailObject.

Benefit quantity M Category code M Category long description N/A Note that the data element is returned as a nil element.

Sub-Category code M Sub-Category long description

N/A Note that the data element is returned as a nil element.

The following table lists the processing rules for the Get Benefit Maintenance History function:

Rule ID Description

4.2.3.1 Validate that the WIC MIS account ID exists.

4.2.3.2 If both WIC MIS account ID and Card number are sent, then the values must both belong to the same account.

4.2.3.3 If WIC MIS account ID is sent, return all benefit maintenance history for the household.

4.2.3.4 If Card number is sent, return all benefit maintenance history for the card.

4.2.3.5 Validate that the Date, begin request to Date, end request timeframe is not greater than the timeframe configured by the WIC State Agency in the Maximum search range – Get Benefit Maintenance History setting (see Appendix D - Configurability).

4.2.4 Get Benefit Redemption History

The Get Benefit Redemption History function is a required function that uses a message based system interface to retrieve benefit redemption data for a particular EBA. This function allows the WIC MIS to retrieve from the WIC EBT system the benefit redemption history for a given period and a specific transaction type for the EBA and display it via the WIC MIS. Any filter parameter values sent with this function will result in the return values being filtered to just those items that match.

Only transactions where redemption was attempted or completed (including those adjusted) are reported.

The following table lists the data elements sent for the Get Benefit Redemption History function:

Card number C Mandatory if WIC MIS account ID not present Date, begin request M Date, end request M Type code O Used to request specific types of maintenance (Add, Void, Purged), see Appendix B.8 for values WIC MIS account ID C Mandatory if Card number not present WIC MIS vendor ID O If provided, only transactions for the specified WIC vendor are retrieved

The following data elements are returned for the Get Benefit Redemption History function:

Data element name Condition Usage Notes Acquiring institution ID code

M Identifies entity that obtained the transaction from the WIC Vendor

Amount, discount M The absolute value of the amounts deducted from the gross amount of the transaction due to coupons or other reductions in the amount

Amount, paid M The Amount, paid at the transaction level shall equal the sum of the Amount, paid of all of the reported line items less the Amount, discount at the transaction level. Also, Amount, paid = Amount, transaction - Amount, discount - Amount, total adjustments.

Amount, total adjustments

M The sum of all adjustments to the reported line items.

Includes adjustments to the transaction for NTE price or other adjustments.

Amount, transaction M The original requested amount. The amount of the transaction before any adjustments or discounts.

Card acceptor identification code

C Mandatory if data element included in transaction from retailer

Card acceptor terminal identification code

C Mandatory if data element included in transaction from retailer

Card number M Date and time, host M Date and time, local transaction

M

Date, business M Date, settlement M As recorded by the EBT system Forwarding institution ID code

M Identifies entity that submitted the transaction for payment

Host generated trace number

M Identifies the Host generated trace number that was assigned to the transaction being reported; for redemptions being reported it contains a host assigned unique identifier (e.g., an approval code or Systems trace audit number). This field is referred to as Unique EBT transaction ID in WUMEI.

Initiating user ID N/A Message reason code C Mandatory if the transaction represents an adjustment. (WIC

Direct does not currently utilize this field. This field will be included in the response message, but will remain uninitialized for now. When WIC Direct implements more formalized adjustment processing, WIC Direct will begin populating this field.)

Original host generated trace number

C For a reversal, refers to the original transaction

POS data code, card data input capability

M

POS data code, cardholder authentication capability

M

POS data code, card capture capability

M

POS data code, operating environment

M

POS data code, cardholder present

M

POS data code, card present

M

POS data code, card data input mode

M

POS data code, cardholder authentication method

M

POS data code, cardholder authentication entity

M

POS data code, card data output capability

M

POS data code, terminal output capability

M

POS data code, PIN capture capability

M

Systems trace audit number

M

Transaction reason code M Value is the action code (bit 39) for WIC Online EBT and will always be set to “000” or “002”; see Technical Implementation Guide for corresponding values. WIC Direct currently only supports the return of approved (or partially approved) redemptions.

Type code M Indicates transaction type (Purchase, Void, Adjustment, etc.);

See Appendix B.8 for values

WIC MIS account ID M WIC MIS WIC Vendor ID M WIC Vendor peer group ID M Workstation ID N/A The following data elements will be repeated for each food item purchased. The object name is RedemptionDetailObject.

Amount, item discount M Amount, NTE adjustment C Mandatory if line item includes an NTE adjustment Amount, recoupment adjustment

C Mandatory if line item includes a recoupment adjustment

Amount, paid M The amount paid to a WIC vendor for a purchase transaction for the specific item purchased less any adjustments. The Amount, paid is equal to the requested Item price as adjusted for NTE and recoupment, times the approved Purchase quantity and cannot be less than zero.

Benefit issuance ID M Original value from the benefits issued at the

WIC MIS account ID level Benefit unit description M Only first 6 characters are significant (this is the same as the

Unit of measure field in the WUMEI that is optional).

Category code M Category code of the benefit applied to the item Category long description N/A Clinic ID C Clinic ID of location that issued the benefit, echoed from original message if present Date, begin benefit M Date, end benefit M Item action code M Item description M Item price M The item price after any adjustments are applied, i.e. Item price = Original item price - Amount, item discount - Amount, NTE adjustment - Amount, recoupment adjustment

Line item ID C Mandatory when a single food item in a purchase requires multiple reporting records to account for applying units across Sub-Categories or Benefit IDs.

Local agency ID C Local agency ID for location that issued the benefit, echoed from original message if present

Original amount M The amount requested by a WIC vendor for a purchase transaction for the specific item purchased. The Original amount is equal to the requested Item price times the approved Original purchase quantity and cannot be less than zero.

Original category code M Category code assigned to the UPC or PLU Original item price M The requested item price before any adjustments Original purchase quantity M The quantity requested as prorated for the specific amount of benefit units redeemed Original sub-category code

M Sub-Category code assigned to the UPC or PLU

Package size C The size of the contents of the package quantified in the standard benefit units of measure

Purchase quantity M The quantity approved as prorated for the specific amount of benefit units redeemed

Sub-Category code M Sub-Category code of the benefit applied to the item Sub-Category long description

N/A

Units M Number of units of benefit of this item redeemed UPC/PLU data M UPC/PLU data length M

The following table lists the processing rules for the Get Benefit Redemption History function:

Rule ID Description

4.2.4.1 Validate that the WIC MIS account ID exists.

4.2.4.2 If both WIC MIS account ID and Card number are sent, then the values must both belong to the same account.

4.2.4.3 If WIC MIS account ID is sent, return all benefit redemption history for the

Household.

4.2.4.4 If Card number is sent, return all benefit redemption history for the card.

4.2.4.5 Transactions utilizing multiple Benefit issuance IDs or where redemption straddles the Sub- Category code and Broadband Sub-Category code shall report all details for each food item redeemed.

4.2.4.6 Validate that the Date, begin request to Date, end request timeframe is not greater than the configured by the WIC State Agency in the Maximum search range – Get Benefit Redemption History setting (see Appendix D - Configurability).

4.3 Cardholder/Card Maintenance

The Cardholder/Card Maintenance functional area comprises functions for maintaining WIC Cardholders and their cards in the WIC EBT System. WIC Cardholders and cards are required to access WIC EBT benefits associated with an EBA in the WIC EBT System.

A WIC Card is issued to a WIC Cardholder. The WIC Cardholder may be the WIC Participant, i.e., the person receiving the benefit, or a proxy such as a parent or caretaker for a child. The WIC Card may contain benefits (WIC Smart Card EBT) or may be linked to benefits (WIC Online EBT) for one or more WIC Participants identified by a WIC MIS account ID. A WIC MIS account ID may include one or more WIC Participants however a single EBA is provided to avoid confusion when redeeming benefits.

4.3.1 Add Cardholder/Card

The Add Cardholder/Card function is a required function that uses a message based system interface to create a WIC Cardholder and an associated Card number.

The following table lists the data elements sent for the Add Cardholder/Card function:

Data element name Condition Usage Notes Cardholder Object M See Appendix C WIC MIS account ID M

The following table lists the processing rules for the Add Cardholder/Card function:

Rule ID Description

4.3.1.1 Validate that the WIC MIS account ID exists and is active.

4.3.1.2 If the cardholder Type code is “Primary”, then the WIC EBT System shall validate that there is not already an active primary cardholder associated with the given household.

4.3.1.3 If the cardholder Type code is not “Primary”, then the WIC EBT System shall validate that there is already a primary cardholder associated with the household.

4.3.1.4 If the cardholder Type code is not “Primary”, then the WIC EBT System shall validate that the addition of the new cardholder will not exceed the maximum number of allowed cardholders per household.

4.3.1.5 If all validations are passed, then the WIC EBT System shall create a new cardholder record and associate the cardholder with the given card and household.

4.3.1.6 Validate that the Card number (in the Cardholder object) is not already issued.

The following table lists the processing rules specific to Reason code and Status code. Note that the Status Code is not used on the send.

Reason code (send)

Status code (result)

Notes

Any valid value A001 (Activated)

The Reason code is not recorded or used in any processing.

4.3.2 Add or Update PIN

The Add or Update PIN function is an optional function that uses a message based system interface to associate a PIN with the cardholder of the given card for WIC Online EBT PIN verification.

The following table lists the data elements sent for the Add or Update PIN function:

Data element name Condition Usage Notes Action code M Change, Unlock see Appendix B.1 for values Card number M PIN, encrypted C Required when used to select (change) a PIN.

The following table lists the processing rules for the Add or Update PIN function:

Rule ID Description

0.1 Validate that the Card number is active and associated with a valid EBA.

0.2 Validate that the PIN, encrypted is valid.

0.3 If the PIN, encrypted is supplied and is valid then the WIC EBT System Processor shall translate the PIN, encrypted into a new PIN, encrypted that is suitable for internal database storage.

0.4 The PIN will be effective upon successful processing of the request by the WIC EBT system.

0.5 If the PIN, encrypted is supplied, then it must be sent in one of three available formats within this method:

1. The first format is for use with DUKPT encryption.

a. The value supplied must be 32 characters long.

b. The first 16 characters must be an unpadded (without the leading

“FFFF” value) KSN.

c. The final 16 characters must be the…