FDMSBenefit Control

Properties   Methods   Events   Config Settings   Errors  

The FDMSBenefit control is used to authorize Electronic Benefits Transfer (EBT) transactions with the FDMS system on the North platform. An EBT transaction is similar to a Debit transaction, using a PIN and KSN, but is used for Food Stamp or Cash Benefit programs. This control allows for simple, direct, secure communication to the First Data platform through a standard Internet connection.

Syntax

FDMSBenefit

Remarks

This control connects to the First Data Merchant Services (FDMS) processor, by way of the Datawire VXN transaction transport network. Transactions originating with these controls go through Datawire, to the FDMS processor where the transaction is authorized. The result is then returned back through Datawire and received by the control. This control can be integrated into web pages or stand-alone Point Of Sale applications. Because all SSL communications are handled inside the control, any application or web page can be deployed without the need for expensive dedicated SSL servers.

An EBT Card (also known as Cash Benefit Card or Food Stamps) works similar to a bank debit card. EBT is a special application of electronic funds transfer (EFT), or debit card technology, which takes money directly from one account and transfers it to another (credit cards, by comparison, simply record a sale for payment later). The steps to setting up the control and sending transactions are outlined below: First, you must register and activate your account with Datawire. Datawire will provide you with a MerchantNumber and MerchantTerminalNumber, but you'll need to use the FDMSRegister control to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through Service Discovery, you may begin to authorize transactions.

To authorize a credit card, set the MerchantNumber and MerchantTerminalNumber with the values supplied by FDMS and Datawire, and the DatawireId with the value retrieved by the FDMSRegister control after activating your merchant account. Set the URL property with one of the URLs you retrieved during Service Discovery.

FDMSBenefit.MerchantNumber = "000000999990" //Supplied by FDMS/Datawire FDMSBenefit.MerchantTerminalNumber = "555555" //Supplied by FDMS/Datawire FDMSBenefit.DatawireId = "0000B47FFFFFFFFFFFFF" //Retrieved with the FDMSRegister control. FDMSBenefit.URL = "https://staging1.datawire.net/sd/"; //Retrieved with the FDMSRegister control. Next, set properties that contain details about the transaction. The TransactionNumber should be incremented for every transaction you send. The TransactionAmount must be set, and it should contain the amount to be charged, with an implied decimal point (ie: $1.00 is "100"). Like the FDMSDebit control, there is no IndustryType property for FDMSBenefit.The format of the transmitted data does not change for different industry types. Do note that the FDMSBenefit component can only be used in a retail (or restaurant, grocery store, etc) environment, where the card and customer are present. The card must be swiped and track2 data must be specified in the CardMagneticStripe property. Cash Benefit transactions may never be manually-keyed, but Food Stamp transactions may be. EBT transactions also require the customer to input his or her PIN into a certified PIN Pad device, which will return an encrypted PIN and a Key Sequence Number to the merchant. These must be submitted with the transaction in the EncryptedPIN and KSN properties. A unique ReceiptNumber number used to identify the transaction on the merchant's system is also required for all transactions. This number must also be printed on the customer's receipt.

EBT transactions differ from credit card authorizations in that they are real-time -- Funds are immediately removed from (or added to) the customer's cash benefit or food stamp account. However, even though EBT transactions are real-time, FDMS requires they be settled at the end of the day just like credit card transactions.

The following transaction set is available for the Cash Benefit BenefitType:

Note that only food stamp transactions may be voice-authorized, attempting to send a VoucherAuthCode or VoucherNumber in a Sale transaction when the BenefitType is set to Cash Benefits will result in an error.

The example below shows how to submit a simple food stamp sale transaction. FDMSBenefit.TransactionNumber = 1 FDMSBenefit.TransactionAmount = "2500" FDMSBenefit.CardMagneticStripe = "5076800000001355=120412000000000123" FDMSBenefit.CardEntryDataSource = edsTrack1 FDMSBenefit.EncryptedPIN = "7B8491A1007E82B0" FDMSBenefit.KSN = "876543210900300000C" FDMSBenefit.ReceiptNumber = "123456" FDMSBenefit1.BenefitType = btFoodStamps FDMSBenefit.Sale

When the control receives a response, the result of the authorization will be available in several Response properties. The ResponseDatawireStatus and ResponseDatawireReturnCode indicate whether any errors occurred while passing the transaction through the Datawire VXN system. These two properties alone do not indicate a successful transaction, they only tell whether or not there were any problems transporting the authorization request and response through the Datawire system. If the transaction was successfully authorized by FDMS, then the ResponseCaptureFlag will be True, and the ResponseApprovalCode will contain an approval code that beings with "AP". (or "AL" for controls that support partially-approved/split-tender transactions). The remaining response properties provide additional information about the transaction, including cash benefit and food stamp account balances (for supported cards).

Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the merchant account. This is done by passing the XML aggregate returned from the GetDetailAggregate method to the FDMSSettle control. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister control. (You may update your list of service provider URLs with the FDMSRegister control's ServiceDiscovery method).

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

ApplicationId Property (FDMSBenefit Control)

Identifies the merchant application to the Datawire System.

Syntax

fdmsbenefitcontrol.ApplicationId[=string]

Default Value

"NSOFTDIRECTPXML"

Remarks

The Application ID includes the Merchant's application name and version number. This property is used to identify the merchant application within the Datawire system, and may be validated along with the MerchantTerminalNumber and DatawireId as connection credentials.

The default value of this property is assigned to the 4D Payments FDMS Integrator, but you may be required to have a new ApplicationId assigned for the software you create with this control.

Data Type

String

BenefitType Property (FDMSBenefit Control)

Indicates whether the EBT card is a Food Stamps card or Cash Benefits card.

Syntax

fdmsbenefitcontrol.BenefitType[=integer]

Possible Values

btFoodStamps(0), 
btCashBenefits(1)

Default Value

0

Remarks

Under the EBT system, food stamp clients apply for their benefits in the usual way, by filling out a form at their local food stamp office. Once eligibility and the level of benefits have been determined, an account is established in the client's name, and food stamp benefits are deposited electronically into the account each month. A plastic card similar to a Debit card is issued, and a personal identification number (PIN) is assigned or chosen by the client to provide access to the account.

When a food stamp client is ready to purchase groceries, the client's card is run through an electronic reader or a POS (point-of-sale) terminal, and the client enters the secret PIN to access the food stamp account. A transaction request is transmitted to the processor for the issuing state. The processor electronically verifies the PIN and account balance and sends either an authorization or a denial back to the retailer. The client's account is debited for the amount of the purchase, and the retailer's account is credited. No money or food stamps change hands.

The following are valid btFoodStamps (0) transactions:

• Sale
• Credit
• Voucher Clear (force) of previously voice-authorized Sale or Credit
• BalanceInquiry
• Any of the above transactions may be manually-keyed if track data cannot be read.

• Sale with CashBack
• CashWithdrawal
• Non-food related items (including alcohol)

Various state and county agencies issue cash benefits for various needs; the most familiar is Temporary Assistance to Needy Families (TANF). If the benefit is issued electronically, it can be spent like cash wherever EBT payments are accepted, it works much like a regular debit card.

The following are valid btCashBenefits (1) transactions:

• Sale
• Sale with CashBack
• BalanceInquiry
• CashWithdrawal (amount is not to be limited, client is permitted to access the remaining available balance)

• Credit (refund to a cash account not permitted)
• Voice authorizations with a voucher clear
• Manually keyed transactions (Track2 is required)

Data Type

Integer

CardType Property (FDMSBenefit Control)

Type of credit card being used in this transaction.

Syntax

fdmsbenefitcontrol.CardType[=integer]

Possible Values

ctUnknown(0), 
ctVisa(1), 
ctMasterCard(2), 
ctAMEX(3), 
ctDiscover(4), 
ctDiners(5), 
ctJCB(6), 
ctVisaElectron(7), 
ctMaestro(8), 
ctLaser(10)

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (FDMSBenefit Control)

Three digit security code on back of card (optional).

Syntax

fdmsbenefitcontrol.CardCVVData[=string]

Default Value

""

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (FDMSBenefit Control)

Indicates the presence of the card verification value.

Syntax

fdmsbenefitcontrol.CardCVVPresence[=integer]

Possible Values

cvpNotProvided(0), 
cvpProvided(1), 
cvpIllegible(2), 
cvpNotOnCard(3)

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

The control will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (FDMSBenefit Control)

This property contains a 1-character code identifying the source of the customer data.

Syntax

fdmsbenefitcontrol.CardEntryDataSource[=integer]

Possible Values

edsTrack1(0), 
edsTrack2(1), 
edsManualEntryTrack1Capable(2), 
edsManualEntryTrack2Capable(3), 
edsManualEntryNoCardReader(4), 
edsTrack1Contactless(5), 
edsTrack2Contactless(6), 
edsManualEntryContactlessCapable(7), 
edsIVR(8), 
edsKiosk(9)

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (FDMSBenefit Control)

Expiration month of the credit card specified in Number .

Syntax

fdmsbenefitcontrol.CardExpMonth[=integer]

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (FDMSBenefit Control)

Expiration year of the credit card specified in Number .

Syntax

fdmsbenefitcontrol.CardExpYear[=integer]

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (FDMSBenefit Control)

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

fdmsbenefitcontrol.CardIsEncrypted[=boolean]

Default Value

False

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (FDMSBenefit Control)

Track data read off of the card's magnetic stripe.

Syntax

fdmsbenefitcontrol.CardMagneticStripe[=string]

Default Value

""

Remarks

Track data read off of the card's magnetic stripe.

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

control.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" control.CardEntryDataSource = edsTrack1 or control.CardMagneticStripe = "4788250000028291=05121015432112345678" control.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (FDMSBenefit Control)

Customer's credit card number for the transaction.

Syntax

fdmsbenefitcontrol.CardNumber[=string]

Default Value

""

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with CardMagneticStripe data, this property should be left empty.

This property is not available at design time.

Data Type

String

CashBack Property (FDMSBenefit Control)

Optional cash back amount to return to the customer.

Syntax

fdmsbenefitcontrol.CashBack[=string]

Default Value

""

Remarks

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The largest possible CashBack amount is "99999", yielding a maximum US dollar amount of $999.99. This field may not contain a negative number.

For cash back transactions, the TransactionAmount must contain the sum total of the purchase amount PLUS the CashBack amount. If the purchase is for $10 and the customer requests $20 cash back, CashBack should be set to "2000" and TransactionAmount must contain "3000".

Note that only US currency is supported for debit transactions.

Note: Cash back is only available for the Cash Benefit sale transactions. See BenefitType for more information.

Data Type

String

DatawireId Property (FDMSBenefit Control)

Identifies the merchant to the Datawire System.

Syntax

fdmsbenefitcontrol.DatawireId[=string]

Default Value

""

Remarks

The Datawire Id is a unique customer identifier generated by Datawire and returned to the client after successfully registering the merchant (using the FDMSRegister control). This Id (which is sent in all subsequent transactions) allows a transaction, to pass through the Datawire system and be correctly routed to the FDMS Payment processor.

The maximum length for this property is 32 characters.

Data Type

String

EncryptedPIN Property (FDMSBenefit Control)

DUKPT DES encrypted pin block, retrieved from a PIN pad.

Syntax

fdmsbenefitcontrol.EncryptedPIN[=string]

Default Value

""

Remarks

A 16-byte encrypted PIN and associated KSN are required for all debit Sale and Credit transactions. These values must be retrieved from a certified DUKPT DES pin pad device.

The EncryptedPIN and KSN are not required for ReverseLastTransaction transactions.

The following code snippet shows how to send a simple debit sale transaction with all required properties. FDMSDebit1.MerchantNumber = "YOURNUMBER" FDMSDebit1.MerchantTerminalNumber = "YOURTERMID" FDMSDebit1.DatawireId = "YOURDID" FDMSDebit1.URL = "https://staging1.datawire.net/sd"; // test server FDMSDebit1.TransactionNumber = 4; FDMSDebit1.TransactionAmount = "100"; FDMSDebit1.Card.EntryDataSource = edsTrack2; FDMSDebit1.Card.MagneticStripe = "9876543210012341234=12041200000001"; // (pin 1234) FDMSDebit1.EncryptedPIN = "0082943935BA205D"; FDMSDebit1.KSN = "8765432109003000012"; FDMSDebit1.ReceiptNumber = "123456"; FDMSDebit1.Sale(); If the transaction is successful, the ResponseApprovalCode will start with "AP", and the ResponseCaptureFlag will be true. Even though debit transactions are on-line transactions, it is still necessary to settle them with First Data. The following example shows how to send a simple settlement. The first thing to do is to set up the FDMSSettle control's properties with the same information used for the debit sale: FDMSSettle1.MerchantNumber = FDMSDebit1.MerchantNumber; FDMSSettle1.MerchantTerminalNumber = FDMSDebit1.MerchantTerminalNumber; FDMSSettle1.DatawireId = FDMSDebit1.DatawireId; FDMSSettle1.URL = FDMSDebit1.URL; FDMSSettle1.MerchantServiceNumber = "8001234567"; FDMSSettle1.BatchSequenceNumber = "101"; FDMSSettle1.IndustryType = itRetail; Then all that needs to be done is add the detail record from the debit sale to the settlement component and call the SendSettlement method. FDMSSettle1.DetailRecords.Add(new FDMSRecordType(FDMSDebit1.GetDetailAggregate()); FDMSSettle1.SendSettlement(); Note that in a live system you would store detail records in a database and send multiple records in a single batch at the end of the business day.

Data Type

String

FDMSPlatform Property (FDMSBenefit Control)

Specifies the FDMS platform that the transactions will be processed on.

Syntax

fdmsbenefitcontrol.FDMSPlatform[=integer]

Possible Values

fpNorth(0), 
fpNashville(1)

Default Value

0

Remarks

This property is used to identify the FDMS platform that the transactions will be sent to and processed on. The following table lists the platforms supported by this control.

Data Type

Integer

KSN Property (FDMSBenefit Control)

Clear-text Key Sequence Number retrieved from a PIN pad.

Syntax

fdmsbenefitcontrol.KSN[=string]

Default Value

""

Remarks

A 19 or 20-byte Key Sequence Number (KSN) and associated EncryptedPIN are required for all debit Sale and Credit transactions. These values must be retrieved from a certified DUKPT DES pin pad device. A 20-byte Key Sequence Number consists of a 1-byte pad character ('F'), a 9-byte Base Derivation Key Id (BDK ID), a 5-byte device Id, and a 5-byte transaction counter. If this property is set with a Key Sequence Number less than 20 bytes in length, the control will pad it on the left with 'F' characters.

The EncryptedPIN and KSN are not required for ReverseLastTransaction transactions.

The following code snippet shows how to send a simple debit sale transaction with all required properties. FDMSDebit1.MerchantNumber = "YOURNUMBER" FDMSDebit1.MerchantTerminalNumber = "YOURTERMID" FDMSDebit1.DatawireId = "YOURDID" FDMSDebit1.URL = "https://staging1.datawire.net/sd"; // test server FDMSDebit1.TransactionNumber = 4; FDMSDebit1.TransactionAmount = "100"; FDMSDebit1.Card.EntryDataSource = edsTrack2; FDMSDebit1.Card.MagneticStripe = "9876543210012341234=12041200000001"; // (pin 1234) FDMSDebit1.EncryptedPIN = "0082943935BA205D"; FDMSDebit1.KSN = "8765432109003000012"; FDMSDebit1.ReceiptNumber = "123456"; FDMSDebit1.Sale(); If the transaction is successful, the ResponseApprovalCode will start with "AP", and the ResponseCaptureFlag will be true. Even though debit transactions are on-line transactions, it is still necessary to settle them with First Data. The following example shows how to send a simple settlement. The first thing to do is to set up the FDMSSettle control's properties with the same information used for the debit sale: FDMSSettle1.MerchantNumber = FDMSDebit1.MerchantNumber; FDMSSettle1.MerchantTerminalNumber = FDMSDebit1.MerchantTerminalNumber; FDMSSettle1.DatawireId = FDMSDebit1.DatawireId; FDMSSettle1.URL = FDMSDebit1.URL; FDMSSettle1.MerchantServiceNumber = "8001234567"; FDMSSettle1.BatchSequenceNumber = "101"; FDMSSettle1.IndustryType = itRetail; Then all that needs to be done is add the detail record from the debit sale to the settlement component and call the SendSettlement method. FDMSSettle1.DetailRecords.Add(new FDMSRecordType(FDMSDebit1.GetDetailAggregate()); FDMSSettle1.SendSettlement(); Note that in a live system you would store detail records in a database and send multiple records in a single batch at the end of the business day.

Data Type

String

MerchantFNSNumber Property (FDMSBenefit Control)

Government-issued number identifying a food-stamp-participating merchant location.

Syntax

fdmsbenefitcontrol.MerchantFNSNumber[=string]

Default Value

""

Remarks

The United States Department of Agriculture, Food and Nutrition Service (FNS) must authorize merchants who wish to accept food stamps. A merchant applies directly to this agency. If the necessary requirements are met, the merchant is issued a certificate with a seven-digit number for each participating merchant location. This number, referred to as the FNS number, uniquely identifies the merchant location to the state EBT processor system. In the FDMS system, this number must be set up in the Cross-Reference File (XREF) under usage indicator I. The number is pulled from the XREF file and inserted into each transaction request before the request is passed on from the front end. This number is used only for Food Stamp transactions

If this number is not supplied, FDMS will attempt to obtain it from a Merchant Control File in their system.

Data Type

String

MerchantNumber Property (FDMSBenefit Control)

A unique number used to identify the merchant within the FDMS and Datawire systems.

Syntax

fdmsbenefitcontrol.MerchantNumber[=string]

Default Value

""

Remarks

This property contains a unique number (typically 12 digits) which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the FDMS and Datawire systems, and is used along with the MerchantTerminalNumber and DatawireId as connection credentials.

Data Type

String

MerchantTerminalNumber Property (FDMSBenefit Control)

Used to identify a unique terminal within a merchant location.

Syntax

fdmsbenefitcontrol.MerchantTerminalNumber[=string]

Default Value

""

Remarks

This property contains a number (typically 6 digits) assigned by FDMS to uniquely identify a terminal within a merchant location, and is used along with the MerchantNumber and DatawireId as connection credentials.

Data Type

String

ProxyAuthScheme Property (FDMSBenefit Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

fdmsbenefitcontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (FDMSBenefit Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

fdmsbenefitcontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (FDMSBenefit Control)

This property contains a password if authentication is to be used for the proxy.

Syntax

fdmsbenefitcontrol.ProxyPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (FDMSBenefit Control)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fdmsbenefitcontrol.ProxyPort[=integer]

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (FDMSBenefit Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fdmsbenefitcontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (FDMSBenefit Control)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fdmsbenefitcontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (FDMSBenefit Control)

This property contains a username if authentication is to be used for the proxy.

Syntax

fdmsbenefitcontrol.ProxyUser[=string]

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ReceiptNumber Property (FDMSBenefit Control)

Merchant generated number used to identify the transaction.

Syntax

fdmsbenefitcontrol.ReceiptNumber[=string]

Default Value

""

Remarks

This property is required for Debit transaction clearing, and should contain a unique 6-digit trace number identifying the transaction. The merchant application should generate a unique number for each Debit or EBT transaction. If a Debit or EBT transaction is voided or reversed, the ReceiptNumber of the original transaction should be used. The receipt number must be passed to the FDMS Host on both the Debit/EBT authorization request and the batch settlement detail. It must also be printed on the customer receipt. Used such, this number satisfies Debit Network Provider requirements.

Data Type

String

ResponseApprovalCode Property (FDMSBenefit Control)

Contains an authorization code when a transaction has been approved, or an error message if declined.

Syntax

fdmsbenefitcontrol.ResponseApprovalCode

Default Value

""

Remarks

Contains an authorization code when a transaction has been approved, or an error message if declined.

This property contains an authorization code when a transaction has been approved. The code will begin with "AP" and will be 8 characters in length. If the transaction was declined, it will contain one of the response messages listed in the table below:

This property is read-only.

Data Type

String

ResponseAvailableBalance Property (FDMSBenefit Control)

Current card balance, including all pending transactions.

Syntax

fdmsbenefitcontrol.ResponseAvailableBalance

Default Value

""

Remarks

Current card balance, including all pending transactions. The available balance is the current Ledger balance, less any holds (due to authorizations), plus any credits or deposits and minus withdrawals, that are all part of the day's activity. If present, this value must be printed on the customer's receipt. If not present, the ResponseEndingBalance should be printed instead (print "Balance Unavailable" if neither are returned in the response).

This property is read-only.

Data Type

String

ResponseBeginningBalance Property (FDMSBenefit Control)

Beginning balance of the EBT account.

Syntax

fdmsbenefitcontrol.ResponseBeginningBalance

Default Value

""

Remarks

Beginning balance of the EBT account. This field indicates what the beginning balance that was deposited into the EBT account for the current period.

This property is read-only.

Data Type

String

ResponseCaptureFlag Property (FDMSBenefit Control)

Indicates whether the authorization was successful, and whether it can be settled.

Syntax

fdmsbenefitcontrol.ResponseCaptureFlag

Default Value

False

Remarks

Indicates whether the authorization was successful, and whether it can be settled.

After an authorization request, the ResponseCaptureFlag will be set to True if the request was successfully processed. This indicates that you may send the transaction on for batch settlement using the FDMSSettle control. If this property is False you should consider the transaction as Declined, and it may not be settled.

This property is read-only.

Data Type

Boolean

ResponseCashAvailableBalance Property (FDMSBenefit Control)

Available cash balance on the EBT card.

Syntax

fdmsbenefitcontrol.ResponseCashAvailableBalance

Default Value

""

Remarks

Available cash balance on the EBT card. EBT cards may be linked to both a Food Stamp account and a Cash Benefit account. In this case, the ResponseAvailableBalance indicates the available balance in the Food Stamp account, and this field indicates the available balance in the Cash Benefit account.

This property is read-only.

Data Type

String

ResponseCashBeginningBalance Property (FDMSBenefit Control)

Beginning cash balance on the EBT card.

Syntax

fdmsbenefitcontrol.ResponseCashBeginningBalance

Default Value

""

Remarks

Beginning cash balance on the EBT card. EBT cards may be linked to both a Food Stamp account and a Cash Benefit account. In this case, the ResponseBeginningBalance indicates the beginning balance in the Food Stamp account, and this field indicates the beginning balance in the Cash Benefit account.

This property is read-only.

Data Type

String

ResponseCashEndingBalance Property (FDMSBenefit Control)

Ending (Current/Ledger) cash balance on the EBT card.

Syntax

fdmsbenefitcontrol.ResponseCashEndingBalance

Default Value

""

Remarks

Ending (Current/Ledger) cash balance on the EBT card. EBT cards may be linked to both a Food Stamp account and a Cash Benefit account. In this case, the ResponseEndingBalance indicates the current balance in the Food Stamp account, and this field indicates the available balance in the Cash Benefit account.

This property is read-only.

Data Type

String

ResponseDatawireReturnCode Property (FDMSBenefit Control)

Contains an error code providing more details about the DatawireStatus received.

Syntax

fdmsbenefitcontrol.ResponseDatawireReturnCode

Default Value

""

Remarks

Contains an error code providing more details about the ResponseDatawireStatus received.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseCaptureFlag and ResponseApprovalCode properties contain the actual transaction result that was returned by FDMS.

The following is a list of possible Datawire return codes:

This property is read-only.

Data Type

String

ResponseDatawireStatus Property (FDMSBenefit Control)

Status of the communication with Datawire.

Syntax

fdmsbenefitcontrol.ResponseDatawireStatus

Default Value

""

Remarks

Status of the communication with Datawire.

When a transaction is successfully passed from the application, through the Datawire system to the FDMS payment processor and back, the ResponseDatawireStatus will be "OK" and the ResponseDatawireReturnCode will be "000". These two properties have NO BEARING on the actual results of any transaction. Even though the transaction has successfully passed through the Datawire system, it can still fail to be processed successfully by FDMS. This property only indicates that the request reached FDMS, and that FDMS responded with some data.

The ResponseCaptureFlag and ResponseApprovalCode properties contains the actual FDMS Transaction Result that was returned.

The following is a list of possible Datawire response status codes:

This property is read-only.

Data Type

String

ResponseEndingBalance Property (FDMSBenefit Control)

Current balance of the EBT card, not including pending authorizations.

Syntax

fdmsbenefitcontrol.ResponseEndingBalance

Default Value

""

Remarks

Current balance of the EBT card, not including pending authorizations. This is also known as the Ledger, or Current balance, and it indicates the actual balance of the EBT card at this moment; it does not reflect any holds or pending transactions that have not yet been settled. If no ResponseAvailableBalance was returned in the response, this ResponseEndingBalance should be printed on the receipt instead (if neither are returned, print "Balance Unavailable").

This property is read-only.

Data Type

String

ResponseTransactionDate Property (FDMSBenefit Control)

Local transaction date returned from the server in MMDDYY format.

Syntax

fdmsbenefitcontrol.ResponseTransactionDate

Default Value

""

Remarks

Local transaction date returned from the server in MMDDYY format.

This six digit field contains a local transaction date calculated by the authorization center. This field should be recorded and submitted in the Batch Settlement.

This property is read-only.

Data Type

String

SSLAcceptServerCertEncoded Property (FDMSBenefit Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fdmsbenefitcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (FDMSBenefit Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fdmsbenefitcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (FDMSBenefit Control)

This is the name of the certificate store for the client certificate.

Syntax

fdmsbenefitcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (FDMSBenefit Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fdmsbenefitcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (FDMSBenefit Control)

This is the type of certificate store for this certificate.

Syntax

fdmsbenefitcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (FDMSBenefit Control)

This is the subject of the certificate used for client authentication.

Syntax

fdmsbenefitcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (FDMSBenefit Control)

This specifies the SSL/TLS implementation to use.

Syntax

fdmsbenefitcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (FDMSBenefit Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fdmsbenefitcontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (FDMSBenefit Control)

A timeout for the control.

Syntax

fdmsbenefitcontrol.Timeout[=integer]

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the control will return with an error after Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionAmount Property (FDMSBenefit Control)

Purchase amount to be authorized.

Syntax

fdmsbenefitcontrol.TransactionAmount[=string]

Default Value

""

Remarks

This property contains the transaction amount to be authorized.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This field may not contain a negative number.

Data Type

String

TransactionNumber Property (FDMSBenefit Control)

Uniquely identifies the transaction.

Syntax

fdmsbenefitcontrol.TransactionNumber[=string]

Default Value

""

Remarks

The TransactionNumber (otherwise known as the Client Reference Number, or ClientRef) uniquely identifies the packet sent by the application to the Datawire system. This parameter stores some unique token of information, and is used to match the response to the initial request sent. For example, the client application could use a static counter that is increased with the each executed request.

For all controls except FDMSGiftCard the maximum length of this property is 14 alphanumeric characters.

The FDMS recommended format is "tttttttVnnnnrrr" where ttttttt is a 7 digit transaction id, V is a constant, and nnn is a 3 digit version number and rrr is a 3 digit revision number. The 6 digit version number is typically static but unique for an application (Example: Version 2.5 = tttttttV002500).

For the Rapid Connect platform, the 6 character version number should be your Project/TPPID value. The entire TransactionNumber must be unique within a 24 hour time period.

The FDMSGiftCard also passes this value to the FDMS Closed Loop Gift Card system as a transaction id, and therefore the following restrictions are enforced: The maximum length is 7 characters. If the first character is an 'X', the remaining characters must be in the range '0' through 'F', indicating a hexadecimal number. Otherwise the FDMS Closed Loop Gift Card system only allows digits in this property.

Data Type

String

URL Property (FDMSBenefit Control)

Location of the Datawire server to which transactions are sent.

Syntax

fdmsbenefitcontrol.URL[=string]

Default Value

"https://staging1.datawire.net/sd/"

Remarks

This is the URL to which all authorization and settlement transactions are sent. This URL is acquired by using the FDMSRegister control. Once you Register and Activate the merchant using the FDMSRegister control, you may then do a Service Discovery. After sending a Service Discovery transaction, the Datawire system will return a list of transaction URLs. The URL from this list with the shortest round-trip transit time from a ping is the URL you should use here.

Note: By default, this property is populated with the Datawire Staging (test) server, and is not the correct URL to use in a production environment. In a production environment, this URL is supplied by the FDMSRegister control.

Data Type

String

VoucherAuthCode Property (FDMSBenefit Control)

Used to clear (force) a food stamp voucher that was previously voice-authorized.

Syntax

fdmsbenefitcontrol.VoucherAuthCode[=string]

Default Value

""

Remarks

If any aspect of the EBT system is down, the merchant may call the issuing state's processor for a voice authorization for Food Stamp transactions only. The merchant must complete a Manual Voucher form (provided by FDMS or state EBT contractor) to obtain the authorization number, the voucher number and the client's signature. This puts a hold on the funds in the client's account for the amount of the voice authorization. To receive payment for the transaction, the merchant must process a Voucher Clear transaction within ten days of the voice authorization. To send a voucher clear, just send a normal Sale or Credit transaction with the VoucherAuthCode and VoucherNumber properties set.

Note that only food stamp transactions may be voice-authorized, attempting to send a VoucherAuthCode or VoucherNumber in a Sale transaction when the BenefitType is set to Cash Benefits will result in an error.

Data Type

String

VoucherNumber Property (FDMSBenefit Control)

Used to clear (force) a food stamp voucher that was previously voice-authorized.

Syntax

fdmsbenefitcontrol.VoucherNumber[=string]

Default Value

""

Remarks

If any aspect of the EBT system is down, the merchant may call the issuing state's processor for a voice authorization for Food Stamp transactions only. The merchant must complete a Manual Voucher form (provided by FDMS or state EBT contractor) to obtain the authorization number, the voucher number and the client's signature. This puts a hold on the funds in the client's account for the amount of the voice authorization. To receive payment for the transaction, the merchant must process a Voucher Clear transaction within ten days of the voice authorization. To send a voucher clear, just send a normal Sale or Credit transaction with the VoucherAuthCode and VoucherNumber properties set.

Note that only food stamp transactions may be voice-authorized, attempting to send a VoucherAuthCode or VoucherNumber in a Sale transaction when the BenefitType is set to Cash Benefits will result in an error.

Data Type

String

BalanceInquiry Method (FDMSBenefit Control)

Retrieves the current balances of Food Stamp and Cash Benefit accounts on an EBT card.

Syntax

fdmsbenefitcontrol.BalanceInquiry 

Remarks

A BalanceInquiry transaction requests that FDMS return the amount of funds remaining on the customer's EBT Card. No charge is made to the customer's card. The balance results from a balance inquiry on a Food Stamps card will be returned in ResponseBeginningBalance, ResponseAvailableBalance, and ResponseEndingBalance. The balance results from an inquiry on a Cash Benefits card will be returned in ResponseCashBeginningBalance, ResponseCashAvailableBalance, and ResponseCashEndingBalance. For a card that accesses both Food Stamp and Cash Benefit accounts, all six balances may be returned.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister control. (You may update your list of service provider URLs with the FDMSRegister control's ServiceDiscovery method).

CashWithdrawal Method (FDMSBenefit Control)

Withdraws cash from a cash benefits account.

Syntax

fdmsbenefitcontrol.CashWithdrawal 

Remarks

This method is used when a customer wishes to withdraw funds from his cash benefit account. This is called a "Cash Only" transaction. There is no item purchased, and the TransactionAmount the customer may withdraw is not to be limited. The customer is permitted to access the remaining available balance in the account. Track2 and PIN entry are required.

This method is only for use with the Cash Benefits BenefitType.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister control. (You may update your list of service provider URLs with the FDMSRegister control's ServiceDiscovery method).

Config Method (FDMSBenefit Control)

Sets or retrieves a configuration setting.

Syntax

fdmsbenefitcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Credit Method (FDMSBenefit Control)

Submits a food stamp credit transaction, returning funds to an EBT card.

Syntax

fdmsbenefitcontrol.Credit 

Remarks

EBT credit (return) transactions are similar to debit credits in that they are real-time -- Funds are immediately added back to the customer's food stamp account, instead of the funds transfer taking place several days after settlement. EBT credits may use track2 data read from the card's magnetic stripe, or be manually keyed. Track1 data is not acceptable. The customer is required to enter enter his PIN number into a certified PIN Pad device, and both an EncryptedPIN and KSN (Key Sequence Number) are returned from the pad to the merchant, and must be submitted in the Credit/Return transaction.

Note that credits are only supported for the food stamp BenefitType. Attempting to send a Credit when the BenefitType is set to Cash Benefits will result in an error.

Even though debit transactions are real-time, FDMS requires they be settled at the end of the day just like credit card transactions.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister control. (You may update your list of service provider URLs with the FDMSRegister control's ServiceDiscovery method).

GetDetailAggregate Method (FDMSBenefit Control)

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

fdmsbenefitcontrol.GetDetailAggregate 

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the FDMSSettle control's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the FDMSDetailRecord control to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the ResponseCaptureFlag is false) the method fails with an error.

An example of how this method is used is shown below:

FDMSRetail.AuthorizeTrack1() If (FDMSRetail.ResponseCaptureFlag = True) Then FDMSSettle.DetailRecordCount = FDMSSettle.DetailRecordCount + 1 FDMSSettle.DetailRecordsAggregate[FDMSSettle.DetailRecordCount - 1] = FDMSRetail.GetDetailAggregate() End If

Interrupt Method (FDMSBenefit Control)

Interrupts the current action.

Syntax

fdmsbenefitcontrol.Interrupt 

Remarks

This method interrupts any processing that the control is currently executing.

Reset Method (FDMSBenefit Control)

Clears all properties to their default values.

Syntax

fdmsbenefitcontrol.Reset 

Remarks

This method clears all properties to their default values.

ReverseLastTransaction Method (FDMSBenefit Control)

Used to reverse/void a previous transaction.

Syntax

fdmsbenefitcontrol.ReverseLastTransaction 

Remarks

This method is used to reverse a previous transaction in the case a response was not received from the host or to void a previous Sale or Credit transaction.

A Timeout Reversal is needed when a terminal initiates a debit transaction (Sale or Credit) to the FDMS host, but the host fails to send a response back to the terminal for any reason. If a transaction times out or you receive a network connectivity error, you should immediately call ReverseLastTransaction. In this situation you don't know whether the host received the request and the response back to you was lost, or if the host ever received the request at all. Therefore the ReverseLastTransaction method can used to reverse the last transaction sent by this control. You must not change any properties or call any other methods (including Reset), as ReverseLastTransaction operates based on the current state of the control.

First Data will always send an ResponseApprovalCode of "AP888888" or "AP868686" on a reversal response, and the ResponseCaptureFlag value will be False. First Data does not check whether the original transaction occurred or not.

If you do not receive a response to the reversal (eg, it also times out), you must continue to call ReverseLastTransaction until you do receive a response.

Note: A Debit Reversal must not be used by the merchant as a way to credit a customer for returned merchandise.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister control. (You may update your list of service provider URLs with the FDMSRegister control's ServiceDiscovery method).

Sale Method (FDMSBenefit Control)

Submits a sale transaction for an Electronic Benefits (EBT) card.

Syntax

fdmsbenefitcontrol.Sale 

Remarks

EBT sale are similar to Debit card transactions in that they are real-time and require an EncryptedPIN and KSN. EBT cards are connected to either a Food Stamp account or a Cash Benefit account, or both. Like debit transactions, EBT transactions also must use track2 data read from the card's magnetic stripe - Track1 data is not acceptable. Food stamp transactions MAY be manually keyed, but cash benefit transactions may NOT be manually keyed. The BenefitType property indicates whether the sale acts on a Food Stamp or Cash Benefit account.

Even though EBT transactions are real-time, FDMS requires they be settled at the end of the day just like credit card transactions.

Important Note: You must ping your list of service provider URLs and update the URL property to the service provider with the shortest response time every 100 transactions, as well as when your application initially starts. This is not a normal ICMP ping - to determine the fastest transaction URL you must use the special Ping method inside the FDMSRegister control. (You may update your list of service provider URLs with the FDMSRegister control's ServiceDiscovery method).

Connected Event (FDMSBenefit Control)

This event is fired immediately after a connection completes (or fails).

Syntax

Sub fdmsbenefitcontrol_Connected(StatusCode As Integer, Description As String)

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

DataPacketIn Event (FDMSBenefit Control)

Fired when receiving a data packet from the transaction server.

Syntax

Sub fdmsbenefitcontrol_DataPacketIn(DataPacket As String)

Remarks

This event fires when a packet is received. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or to extract additional response properties beyond the scope of this control.

DataPacketOut Event (FDMSBenefit Control)

Fired when sending a data packet to the transaction server.

Syntax

Sub fdmsbenefitcontrol_DataPacketOut(DataPacket As String)

Remarks

This event fires right before each data packet is sent. The entire data packet (including all framing and error detection characters) is contained in the parameter "DataPacket". This parameter may be inspected for advanced troubleshooting, or may be modified to support additional features beyond the scope of this control.

Disconnected Event (FDMSBenefit Control)

This event is fired when a connection is closed.

Syntax

Sub fdmsbenefitcontrol_Disconnected(StatusCode As Integer, Description As String)

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Please refer to the Error Codes section for more information.

Error Event (FDMSBenefit Control)

Fired when information is available about errors during data delivery.

Syntax

Sub fdmsbenefitcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (FDMSBenefit Control)

Fired after the server presents its certificate to the client.

Syntax

Sub fdmsbenefitcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (FDMSBenefit Control)

Fired when secure connection progress messages are available.

Syntax

Sub fdmsbenefitcontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Status Event (FDMSBenefit Control)

Shows the progress of the FDMS/Datawire connection.

Syntax

Sub fdmsbenefitcontrol_Status(Message As String)

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (FDMSBenefit Control)

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (FDMSBenefit Control)

FDMSBenefit Errors

The control may also return one of the following error codes, which are inherited from other controls.

HTTP Errors

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

SSL Errors

TCP/IP Errors