FDMSBenefit Component

Properties   Methods   Events   Config Settings   Errors  

The FDMSBenefit component 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 component allows for simple, direct, secure communication to the First Data platform through a standard Internet connection.

Syntax

DPayments.DPaymentsSDK.Fdmsbenefit

Remarks

This component connects to the First Data Merchant Services (FDMS) processor, by way of the Datawire VXN transaction transport network. Transactions originating with these components go through Datawire, to the FDMS processor where the transaction is authorized. The result is then returned back through Datawire and received by the component. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all SSL communications are handled inside the component, 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 component 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 component 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 component 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 component. FDMSBenefit.URL = "https://staging1.datawire.net/sd/"; //Retrieved with the FDMSRegister component. 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 component, 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 MagneticStripe field. 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.Card.MagneticStripe = "5076800000001355=120412000000000123"; FDMSBenefit.Card.EntryDataSource = edsTrack2; FDMSBenefit.EncryptedPIN = "7B8491A1007E82B0"; FDMSBenefit.KSN = "876543210900300000C"; FDMSBenefit.ReceiptNumber = "123456"; FDMSBenefit1.BenefitType = btFoodStamps; FDMSBenefit.Sale();

When the component receives a response, the result of the authorization will be available in several Response properties. The DatawireStatus and DatawireReturnCode 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 CaptureFlag will be True, and the ApprovalCode will contain an approval code that beings with "AP". (or "AL" for components 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 component. 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Property List

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

Method List

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

Event List

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

Config Settings

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

ApplicationId Property (FDMSBenefit Component)

Identifies the merchant application to the Datawire System.

Syntax

• C#
• VB.NET

public string ApplicationId { get; set; }

Public Property ApplicationId As 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 component.

BenefitType Property (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public FdmsbenefitBenefitTypes BenefitType { get; set; }

enum FdmsbenefitBenefitTypes {
  btFoodStamps,
  btCashBenefits
}

Public Property BenefitType As FdmsbenefitBenefitTypes

Enum FdmsbenefitBenefitTypes
  btFoodStamps
  btCashBenefits
End Enum

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)

Card Property (FDMSBenefit Component)

Contains the customer's credit card information.

Syntax

• C#
• VB.NET

public CCCard Card { get; set; }

Public Property Card As CCCard

Remarks

This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.

Note, track1 data is not valid for EBT cards. You may only the track2 data on the card, or enter the card number manually.

This property is not available at design time.

CashBack Property (FDMSBenefit Component)

Optional cash back amount to return to the customer.

Syntax

• C#
• VB.NET

public string CashBack { get; set; }

Public Property CashBack As 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.

DatawireId Property (FDMSBenefit Component)

Identifies the merchant to the Datawire System.

Syntax

• C#
• VB.NET

public string DatawireId { get; set; }

Public Property DatawireId As 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 component). 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.

EncryptedPIN Property (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public string EncryptedPIN { get; set; }

Public Property EncryptedPIN As 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 ApprovalCode will start with "AP", and the CaptureFlag 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 component'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.

FDMSPlatform Property (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public FdmsbenefitFDMSPlatforms FDMSPlatform { get; set; }

enum FdmsbenefitFDMSPlatforms {
  fpNorth,
  fpNashville
}

Public Property FDMSPlatform As FdmsbenefitFDMSPlatforms

Enum FdmsbenefitFDMSPlatforms
  fpNorth
  fpNashville
End Enum

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 component.

KSN Property (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public string KSN { get; set; }

Public Property KSN As 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 component 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 ApprovalCode will start with "AP", and the CaptureFlag 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 component'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.

MerchantFNSNumber Property (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public string MerchantFNSNumber { get; set; }

Public Property MerchantFNSNumber As 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.

MerchantNumber Property (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public string MerchantNumber { get; set; }

Public Property MerchantNumber As 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.

MerchantTerminalNumber Property (FDMSBenefit Component)

Used to identify a unique terminal within a merchant location.

Syntax

• C#
• VB.NET

public string MerchantTerminalNumber { get; set; }

Public Property MerchantTerminalNumber As 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.

Proxy Property (FDMSBenefit Component)

A set of properties related to proxy access.

Syntax

• C#
• VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

This property contains fields describing the proxy through which the component will attempt to connect.

ReceiptNumber Property (FDMSBenefit Component)

Merchant generated number used to identify the transaction.

Syntax

• C#
• VB.NET

public string ReceiptNumber { get; set; }

Public Property ReceiptNumber As 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.

Response Property (FDMSBenefit Component)

Contains the response to an EBT transaction.

Syntax

• C#
• VB.NET

public FDMSBenefitResponse Response { get; }

Public ReadOnly Property Response As FDMSBenefitResponse

Remarks

This property will contain the response returned from the FDMS server. It should be inspected (and logged) after an authorization to determine if the transaction was approved. The FDMSBenefitResponse type contains the following fields:

This property is read-only.

SSLAcceptServerCert Property (FDMSBenefit Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (FDMSBenefit Component)

The certificate to be used during SSL negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (FDMSBenefit Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public FdmsbenefitSSLProviders SSLProvider { get; set; }

enum FdmsbenefitSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As FdmsbenefitSSLProviders

Enum FdmsbenefitSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

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 component 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 component will select a provider depending on the current platform.

When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

The .NET Standard library will always use the internal implementation on all platforms.

SSLServerCert Property (FDMSBenefit Component)

The server certificate for the last established connection.

Syntax

• C#
• VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Timeout Property (FDMSBenefit Component)

A timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

30

Remarks

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

The default value for Timeout is 30 (seconds).

TransactionAmount Property (FDMSBenefit Component)

Purchase amount to be authorized.

Syntax

• C#
• VB.NET

public string TransactionAmount { get; set; }

Public Property TransactionAmount As 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.

TransactionNumber Property (FDMSBenefit Component)

Uniquely identifies the transaction.

Syntax

• C#
• VB.NET

public string TransactionNumber { get; set; }

Public Property TransactionNumber As 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 components 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.

URL Property (FDMSBenefit Component)

Location of the Datawire server to which transactions are sent.

Syntax

• C#
• VB.NET

public string URL { get; set; }

Public Property URL As 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 component. Once you Register and Activate the merchant using the FDMSRegister component, 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 component.

VoucherAuthCode Property (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public string VoucherAuthCode { get; set; }

Public Property VoucherAuthCode As 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.

VoucherNumber Property (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public string VoucherNumber { get; set; }

Public Property VoucherNumber As 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.

BalanceInquiry Method (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public void BalanceInquiry();

Public Sub 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 BeginningBalance, AvailableBalance, and EndingBalance. The balance results from an inquiry on a Cash Benefits card will be returned in CashBeginningBalance, CashAvailableBalance, and CashEndingBalance. 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

CashWithdrawal Method (FDMSBenefit Component)

Withdraws cash from a cash benefits account.

Syntax

• C#
• VB.NET

public void CashWithdrawal();

Public Sub 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Config Method (FDMSBenefit Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

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

Syntax

• C#
• VB.NET

public void Credit();

Public Sub 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

GetDetailAggregate Method (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public string GetDetailAggregate();

Public Function GetDetailAggregate() As String

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 component'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 component to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful (and the CaptureFlag is false) the method throws an exception.

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

FDMSRetail.AuthorizeTrack1() if (FDMSRetail.ResponseCaptureFlag) { FDMSSettle.DetailRecords.Add(new FDMSRecordType(FDMSRetail.GetDetailAggregate())); }

Interrupt Method (FDMSBenefit Component)

Interrupts the current action.

Syntax

• C#
• VB.NET

public void Interrupt();

Public Sub Interrupt()

Remarks

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

Reset Method (FDMSBenefit Component)

Clears all properties to their default values.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

This method clears all properties to their default values.

ReverseLastTransaction Method (FDMSBenefit Component)

Used to reverse/void a previous transaction.

Syntax

• C#
• VB.NET

public void ReverseLastTransaction();

Public Sub 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 component. You must not change any properties (or fields of properties) or call any other methods (including Reset), as ReverseLastTransaction operates based on the current state of the component.

First Data will always send an ApprovalCode of "AP888888" or "AP868686" on a reversal response, and the CaptureFlag 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Sale Method (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public void Sale();

Public Sub 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 component. (You may update your list of service provider URLs with the FDMSRegister component's ServiceDiscovery method).

Connected Event (FDMSBenefit Component)

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

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, FdmsbenefitConnectedEventArgs e);

public class FdmsbenefitConnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As FdmsbenefitConnectedEventArgs)

Public Class FdmsbenefitConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

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.

Please refer to the Error Codes section for more information.

DataPacketIn Event (FDMSBenefit Component)

Fired when receiving a data packet from the transaction server.

Syntax

• C#
• VB.NET

public event OnDataPacketInHandler OnDataPacketIn;

public delegate void OnDataPacketInHandler(object sender, FdmsbenefitDataPacketInEventArgs e);

public class FdmsbenefitDataPacketInEventArgs : EventArgs {
  public string DataPacket { get; }
  public byte[] DataPacketB { get; }
}

Public Event OnDataPacketIn As OnDataPacketInHandler

Public Delegate Sub OnDataPacketInHandler(sender As Object, e As FdmsbenefitDataPacketInEventArgs)

Public Class FdmsbenefitDataPacketInEventArgs Inherits EventArgs
  Public ReadOnly Property DataPacket As String
  Public ReadOnly Property DataPacketB As Byte()
End Class

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 component.

DataPacketOut Event (FDMSBenefit Component)

Fired when sending a data packet to the transaction server.

Syntax

• C#
• VB.NET

public event OnDataPacketOutHandler OnDataPacketOut;

public delegate void OnDataPacketOutHandler(object sender, FdmsbenefitDataPacketOutEventArgs e);

public class FdmsbenefitDataPacketOutEventArgs : EventArgs {
  public string DataPacket { get; }
  public byte[] DataPacketB { get; }
}

Public Event OnDataPacketOut As OnDataPacketOutHandler

Public Delegate Sub OnDataPacketOutHandler(sender As Object, e As FdmsbenefitDataPacketOutEventArgs)

Public Class FdmsbenefitDataPacketOutEventArgs Inherits EventArgs
  Public ReadOnly Property DataPacket As String
  Public ReadOnly Property DataPacketB As Byte()
End Class

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 component.

Disconnected Event (FDMSBenefit Component)

This event is fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, FdmsbenefitDisconnectedEventArgs e);

public class FdmsbenefitDisconnectedEventArgs : EventArgs {
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As FdmsbenefitDisconnectedEventArgs)

Public Class FdmsbenefitDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

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.

Please refer to the Error Codes section for more information.

Error Event (FDMSBenefit Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, FdmsbenefitErrorEventArgs e);

public class FdmsbenefitErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As FdmsbenefitErrorEventArgs)

Public Class FdmsbenefitErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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 Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, FdmsbenefitSSLServerAuthenticationEventArgs e);

public class FdmsbenefitSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As FdmsbenefitSSLServerAuthenticationEventArgs)

Public Class FdmsbenefitSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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 Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, FdmsbenefitSSLStatusEventArgs e);

public class FdmsbenefitSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As FdmsbenefitSSLStatusEventArgs)

Public Class FdmsbenefitSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

Status Event (FDMSBenefit Component)

Shows the progress of the FDMS/Datawire connection.

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, FdmsbenefitStatusEventArgs e);

public class FdmsbenefitStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As FdmsbenefitStatusEventArgs)

Public Class FdmsbenefitStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

CCCard Type

Contains the customer's credit card information.

Remarks

This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the component are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the component will look for MagneticStripe data when authorizing the transaction, and will throws an exception because none is present.

Fields

Constructors

• C#
• VB.NET

public CCCard();

Public CCCard()

• C#
• VB.NET

public CCCard(string number, int expMonth, int expYear);

Public CCCard(ByVal Number As String, ByVal ExpMonth As Integer, ByVal ExpYear As Integer)

• C#
• VB.NET

public CCCard(string magneticStripe, EntryDataSources entryDataSource);

Public CCCard(ByVal MagneticStripe As String, ByVal EntryDataSource As EntryDataSources)

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X.509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X.509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

FDMSBenefitResponse Type

Contains the response to the EBT transaction..

Remarks

This type contains the results of a transaction made with the FDMSBenefit component. The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public FDMSBenefitResponse();

Public FDMSBenefitResponse()

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

Fields

Constructors

• C#
• VB.NET

public Proxy();

Public Proxy()

• C#
• VB.NET

public Proxy(string server, int port);

Public Proxy(ByVal Server As String, ByVal Port As Integer)

• C#
• VB.NET

public Proxy(string server, int port, string user, string password);

Public Proxy(ByVal Server As String, ByVal Port As Integer, ByVal User As String, ByVal Password As String)

Config Settings (FDMSBenefit Component)

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 Component)

FDMSBenefit Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors