FDMSOmahaRetail Component

Properties   Methods   Events   Config Settings   Errors  

The FDMSOmahaRetail component is used to perform Credit, Debit, or EBT card transactions in a Retail environment, where the customer is purchasing products or services in person.

Syntax

DPayments.DPaymentsSDK.Fdmsomaharetail

Remarks

This component allows for a connection to the FDMS FDMSOmaha platform via a VPN or PPP (dial-up) connection. This component can be integrated into web pages or stand-alone Point Of Sale applications.

The FDMSOmahaRetail component makes authorizing Card-Present transactions (where the customer's card is swiped through a card reader) very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the component and authorizing a transaction are outlined below:

First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance: FDMSOmahaRetail.MerchantNumber = "123456789123456" FDMSOmahaRetail.MerchantTerminalID = "XXX01" FDMSOmahaRetail.DeviceId = "DID1" // Optional, Merchant-Assigned

Next, set properties that contain details about the transaction. At the minimum, you must set a BatchNumber, TransactionNumber, and TransactionAmount. The TransactionNumber is a sequence number, and should be incremented (for Credit Card transactions) or decremented (for Debit/EBT Card transactions) for each transaction you send. TransactionAmount is the amount of sale formatted with two decimal places. FDMSOmahaRetail.BatchNumber = 1 FDMSOmahaRetail.TransactionNumber = 1 FDMSOmahaRetail.TransactionAmount = "1.00"

Now for Credit Card transactions, set the credit card properties. If available, you should use Track1 data. Some cards may have a corrupt or missing Track1, and for these cards you may use Track2 data. If the card is not readable, you may also manually enter the card number and expiration date. The following example shows a transaction sent with Track1 data. FDMSOmahaRetail.Card.MagneticStripe = "%B4444333322221111^SMITH/JOHN J ^031210100000033301000000008000000?" FDMSOmahaRetail.Card.EntryDataSource = edsTrack1

For Debit Card transactions, set the Track2 Card data along with the DebitPIN and DebitKSN. Additionally you will need to set the TransactionNumber as Debit/EBT transactions start at 999 and decrement after each successful transaction. FDMSOmahaRetail.TransactionNumber = 999 FDMSOmahaRetail.Card.EntryDataSource = edsTrack2 FDMSOmahaRetail.Card.MagneticStripe = "4017779999999999=16041200000000001" FDMSOmahaRetail.DebitKSN = "876543210A005611119" FDMSOmahaRetail.DebitPIN = "8741F3581F20D1D1"

For EBT Card transactions, first set the EBTPaymentType to the card type being used. Then set the Track2 Card data along with the DebitPIN and DebitKSN. Additionally you will need to set the TransactionNumber as Debit/EBT transactions start at 999 and decrement after each successful transaction. FDMSOmahaRetail.TransactionNumber = 998 FDMSOmahaRetail.EBTPaymentType = etCashBenefits FDMSOmahaRetail.Card.EntryDataSource = edsTrack2 FDMSOmahaRetail.Card.MagneticStripe = "4017779999999999=16041200000000001" FDMSOmahaRetail.DebitKSN = "876543210A005611119" FDMSOmahaRetail.DebitPIN = "8741F3581F20D1D1"

Finally, submit the transaction by calling Sale. The following code demonstrates a purchase: FDMSOmahaRetail.Sale()

For Credit Card transactions only, you can use the AuthOnly transaction.

For Debit and EBT transactions, the DebitRefund method can also be called.

For EBT transactions only, the EBTBalanceInquiry and EBTCashWithdrawal can be called.

When the component receives a response from the FDMS FDMSOmaha servers, the result of the authorization will be displayed in the Response properties. Success indicates whether the transaction was approved. The remaining properties provide additional information about the transaction.

Once a Sale, DebitRefund, or EBTCashWithdrawal transaction is approved, the DetailAggregate must be added to the FDMSOmahaBatchMgr component to be used when the batch is closed.

For AuthOnly transactions, they must first be captured via the FDMSOmahaDetailRecord component for the funds to be flagged for transfer. Once captured the DetailAggregate can then be added to the FDMSOmahaBatchMgr component to be used when the batch is closed.

After all the wanted detail records have been added to the FDMSOmahaBatchMgr component, the batch can be closed to start the settlement process and initiate the transfer of the funds.

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 (FDMSOmahaRetail 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.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

BatchNumber Property (FDMSOmahaRetail Component)

Number identifying the batch (assigned by the POS device).

Syntax

• C#
• VB.NET

public int BatchNumber { get; set; }

Public Property BatchNumber As Integer

Default Value

0

Remarks

This property is used to specify the number identifying the batch that the transaction will be processed in.

This is a consecutive numbering system assigned by the POS application that identifies a batch of transactions. The batch number must increment each time a batch is successfully closed. When the batch number reaches 9, it is the responsibility of the application to recycle the batch number to 0. The Host will allow a variety of sequencing of the batch number, but you cannot have the same batch number in consecutive batches. For example: The application can close batch 2 and open the next batch with number 5, but you cannot close batch 2 then re-open batch 2 without a different batch number in between. If you should receive a message of "INV BATCH SEQ", this usually indicates the current batch number is the same as the previous batch number closed or there is a batch still open on the Host and the application is trying to process a transaction with a different batch number. If a batch is left open for more than 45 days, (45 days from the open date, not last activity date), the system will automatically purge the batch and it will not be retrievable.

Valid values: 0-9

Card Property (FDMSOmahaRetail 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.

This property is not available at design time.

ClientRef Property (FDMSOmahaRetail Component)

Uniquely identifies the transaction within the Datawire system.

Syntax

• C#
• VB.NET

public string ClientRef { get; set; }

Public Property ClientRef As String

Default Value

""

Remarks

The ClientRef (Client Reference Number) 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.

The maximum length of this property is 14 alphanumeric characters.

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

The entire TransactionNumber must be unique within a 24 hour time period.

Note: If a value is not specified, the component will generate a value for you. The transaction id will be generated based on the current time (hour of day and minutes) along with the TransactionNumber specified. The version number is hard-coded based on the current library version which is 16.X.X (016XX0).

CustomerCode Property (FDMSOmahaRetail Component)

Merchant-assigned customer code.

Syntax

• C#
• VB.NET

public string CustomerCode { get; set; }

Public Property CustomerCode As String

Default Value

""

Remarks

This property is used to specify a merchant-assigned code identifying the customer of the transaction.

Note: This is a mandatory field for supporting Amex Level 2 Transactions.

DatawireId Property (FDMSOmahaRetail 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.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

DebitCashBackAmount Property (FDMSOmahaRetail Component)

Optional cash back amount to return to the customer.

Syntax

• C#
• VB.NET

public string DebitCashBackAmount { get; set; }

Public Property DebitCashBackAmount As String

Default Value

""

Remarks

This property contains the total dollar-and-cent amount ($$$.��) of cash back to return to the customer. This value is only used for Debit and EBT transactions.

Note: This is a reporting field only. Therefore the DebitCashBackAmount must be accounted for within TransactionAmount.

Note: The decimal point is required to be specified within the amount.

DebitKSN Property (FDMSOmahaRetail Component)

Clear-text Key Sequence Number, used for Debit and EBT transactions.

Syntax

• C#
• VB.NET

public string DebitKSN { get; set; }

Public Property DebitKSN As String

Default Value

""

Remarks

A 19 or 20-byte Key Sequence Number (KSN) and associated DebitPIN are required for all Debit Sale and DebitRefund 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 DebitPIN and DebitKSN are not used for Food Stamp Voucher transactions.

DebitPIN Property (FDMSOmahaRetail Component)

DUKPT DES encrypted PIN block, used for Debit and EBT transactions.

Syntax

• C#
• VB.NET

public string DebitPIN { get; set; }

Public Property DebitPIN As String

Default Value

""

Remarks

A 16-byte encrypted PIN block and associated DebitKSN are required for all Debit Sale and DebitRefund transactions. The value of this property must be retrieved from a certified DUKPT DES pin pad device.

The DebitPIN and DebitKSN are not used for Food Stamp Voucher transactions.

DeviceId Property (FDMSOmahaRetail Component)

POS Device Identification.

Syntax

• C#
• VB.NET

public string DeviceId { get; set; }

Public Property DeviceId As String

Default Value

""

Remarks

Merchant-assigned code identifying the device at the merchant's location.

This field is required if there is one MerchantNumber assigned to more than one terminal at a merchant's location.

The maximum length of this property is 4 characters.

EBTPaymentType Property (FDMSOmahaRetail Component)

Indicates the type of EBT transaction to process.

Syntax

• C#
• VB.NET

public FdmsomaharetailEBTPaymentTypes EBTPaymentType { get; set; }

enum FdmsomaharetailEBTPaymentTypes {
  etNotApplicable,
  etFoodStamps,
  etCashBenefits
}

Public Property EBTPaymentType As FdmsomaharetailEBTPaymentTypes

Enum FdmsomaharetailEBTPaymentTypes
  etNotApplicable
  etFoodStamps
  etCashBenefits
End Enum

Default Value

0

Remarks

This property is used to specify the type of EBT transaction to send.

The default value is etNotApplicable which is used for Credit or Debit card purchases.

EBTVoucherCode Property (FDMSOmahaRetail Component)

Used to clear (force) a Food Stamp Voucher that was previously voice-authorized.

Syntax

• C#
• VB.NET

public string EBTVoucherCode { get; set; }

Public Property EBTVoucherCode 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 EBTVoucherCode and EBTVoucherNumber properties set.

Note: Voucher transactions are only sent because of a POS System or EBT Network unavailable condition.

EBTVoucherNumber Property (FDMSOmahaRetail Component)

Used to clear (force) a Food Stamp Voucher that was previously voice-authorized.

Syntax

• C#
• VB.NET

public string EBTVoucherNumber { get; set; }

Public Property EBTVoucherNumber 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 EBTVoucherCode and EBTVoucherNumber properties set.

Note: Voucher transactions are only sent because of a POS System or EBT Network unavailable condition.

InvoiceNumber Property (FDMSOmahaRetail Component)

Merchant-defined invoice number.

Syntax

• C#
• VB.NET

public string InvoiceNumber { get; set; }

Public Property InvoiceNumber As String

Default Value

""

Remarks

This property is used to specify an invoice number as defined by the merchant.

The maximum length of this field is 8 characters.

LocalHost Property (FDMSOmahaRetail Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

LocalPort Property (FDMSOmahaRetail Component)

The TCP port in the local host where the component binds.

Syntax

• C#
• VB.NET

public int LocalPort { get; set; }

Public Property LocalPort As Integer

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

MerchantNumber Property (FDMSOmahaRetail Component)

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

Syntax

• C#
• VB.NET

public string MerchantNumber { get; set; }

Public Property MerchantNumber As String

Default Value

""

Remarks

This 19 digit property contains a unique number which is assigned by the signing merchant's bank or processor. This field is used to identify the merchant within the FDMS systems, and is used along with the MerchantTerminalNumber as connection credentials.

MerchantTerminalID Property (FDMSOmahaRetail Component)

Used to identify a unique terminal within a merchant location.

Syntax

• C#
• VB.NET

public string MerchantTerminalID { get; set; }

Public Property MerchantTerminalID As String

Default Value

""

Remarks

This nine digit property contains an ID assigned by FDMS to uniquely identify a terminal within a merchant location, and is used along with the MerchantNumber as connection credentials.

OperatorID Property (FDMSOmahaRetail Component)

Merchant-assigned operator code identifying the operator who entered the transaction.

Syntax

• C#
• VB.NET

public string OperatorID { get; set; }

Public Property OperatorID As String

Default Value

""

Remarks

This property is used to specify the ID of the operator (such as a cashier or server) who entered the transaction.

The maximum length for this field is 4.

OrderNumber Property (FDMSOmahaRetail Component)

Merchant-defined number identifying the purchase or service.

Syntax

• C#
• VB.NET

public string OrderNumber { get; set; }

Public Property OrderNumber As String

Default Value

""

Remarks

This property is used to specify an order number to identify the purchase or service.

The maximum length is 25 characters.

Proxy Property (FDMSOmahaRetail 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.

RemoteHost Property (FDMSOmahaRetail Component)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Syntax

• C#
• VB.NET

public string RemoteHost { get; set; }

Public Property RemoteHost As String

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

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

If the component is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Example. Connecting:

TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

RemotePort Property (FDMSOmahaRetail Component)

This property includes the Transmission Control Protocol (TCP) port in the remote host.

Syntax

• C#
• VB.NET

public int RemotePort { get; set; }

Public Property RemotePort As Integer

Default Value

0

Remarks

This property specifies a service port on the remote host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Note: This property is only applicable when TransportProtocol is set to '1' (VPN Connection).

Response Property (FDMSOmahaRetail Component)

Contains the response to an authorization request.

Syntax

• C#
• VB.NET

public FDMSOmahaResponse Response { get; }

Public ReadOnly Property Response As FDMSOmahaResponse

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 FDMSOmahaResponse type contains the following fields:

This property is read-only.

ShipToZipCode Property (FDMSOmahaRetail Component)

The zip code where the purchased items will be shipped to.

Syntax

• C#
• VB.NET

public string ShipToZipCode { get; set; }

Public Property ShipToZipCode As String

Default Value

""

Remarks

This field is used to specify the zip code where the purchased items will be shipped to.

Note: This is a mandatory field for supporting Amex Level 2 Transactions.

SSLAcceptServerCert Property (FDMSOmahaRetail 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 (FDMSOmahaRetail 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 (FDMSOmahaRetail Component)

This specifies the SSL/TLS implementation to use.

Syntax

• C#
• VB.NET

public FdmsomaharetailSSLProviders SSLProvider { get; set; }

enum FdmsomaharetailSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As FdmsomaharetailSSLProviders

Enum FdmsomaharetailSSLProviders
  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 (FDMSOmahaRetail 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.

SurchargeAmount Property (FDMSOmahaRetail Component)

Dollar-and-cent amount of the charge for the purchase.

Syntax

• C#
• VB.NET

public string SurchargeAmount { get; set; }

Public Property SurchargeAmount As String

Default Value

""

Remarks

This field is optional and has a maximum length of 9 characters, the format is as follows: "-99999.99" or "+99999.99". It contains the total dollar-and-cent amount ($$$$$.cc) of the charge that the cardholder paid the merchant for the ability to perform the transaction. Position 1 contains the surcharge prefix. Positions 2-9 contain the surcharge amount.

Note: This is a reporting field only. Therefore the SurchargeAmount must be accounted for within TransactionAmount.

Note: The decimal point is required to be specified within the amount.

TaxAmount Property (FDMSOmahaRetail Component)

Dollar-and-cent amount of tax for the purchase.

Syntax

• C#
• VB.NET

public string TaxAmount { get; set; }

Public Property TaxAmount As String

Default Value

""

Remarks

This field contains the total dollar-and-cent amount ($$$.cc) of the tax for the purchase.

Note: This is a reporting field only. Therefore the TaxAmount must be accounted for within TransactionAmount.

Note: The decimal point is required to be specified within the amount.

Note: This is a mandatory field for supporting Amex Level 2 Transactions.

Timeout Property (FDMSOmahaRetail 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).

TPPID Property (FDMSOmahaRetail Component)

Third Party Processor Identifier assigned by FDMS.

Syntax

• C#
• VB.NET

public string TPPID { get; set; }

Public Property TPPID As String

Default Value

"V4D001"

Remarks

The Third Party Processor Identifier (TPPID. Also sometimes referred to as a "Vendor Id") is assigned by FDMS to each third party who is processing transactions. Each merchant will receive a TPPID from FDMS.

The default value for 4D Payments, Inc. on the Omaha platform is "V4D001".

A VisaIdentifier is also required for Visa transactions.

TransactionAmount Property (FDMSOmahaRetail Component)

Purchase amount to be charged to the cardholders account.

Syntax

• C#
• VB.NET

public string TransactionAmount { get; set; }

Public Property TransactionAmount As String

Default Value

""

Remarks

This property contains the total dollar-and-cent amount ($$$$$.cc) to be charged to the cardholders account.

The TransactionAmount should contain all additional amounts (such as taxes, tips, etc.) as those fields are for reporting purposes only and NOT added to the TransactionAmount by the host.

Note: The decimal point is required to be specified within the amount.

TransactionNumber Property (FDMSOmahaRetail Component)

The transaction number for the current transaction.

Syntax

• C#
• VB.NET

public int TransactionNumber { get; set; }

Public Property TransactionNumber As Integer

Default Value

0

Remarks

This property is used to specify the transaction number for the current transaction. The valid values are 0 - 999. A TransactionNumber of 0 is only used and MUST be used for AuthOnly transactions, thus all other transaction types must have a TransactionNumber of 1 or greater. The maximum value of TransactionNumber is 999 (note: closing a batch requires an item number and thus the actual number of transactions in a batch is 998).

If a transaction is unsuccessful the TransactionNumber should be re-used.

For Credit Card transactions, the TransactionNumber starts at 1 (provided it is not an AuthOnly transaction) and must increment with each successful transaction.

For Debit/EBT Card transactions, the TransactionNumber starts at 999 and must decrement with each successful transaction.

Note TransactionNumbers for Credit Card and Debit/EBT cards *cannot* overlap and must be unique. Additionally, there must be an open TransactionNumber for the close batch transaction. For example, you can have 1-454 for Credit Card transactions and 456-999 for Debit/EBT cards but TransactionNumber 455 must be left available for the close batch transaction.

Item numbers do NOT have to be processed in sequence (i.e. 1, 2, 3, etc.). However, when a batch is closed all transactions up to the TransactionNumber specified to close the batch must be accounted for. For example; if a batch is closed using TransactionNumber 5, transactions 1, 2, 3, and 4 MUST be accounted for. Additionally, if the batch is closed using an TransactionNumber that is not one more than the number of items in the batch, the Host will delete all records over the close TransactionNumber. For example; if a batch is closed using TransactionNumber 5, transaction records 5, 6, 7, etc. will be automatically deleted by the system.

Each transaction that posts to the Host with an TransactionNumber must keep that TransactionNumber until the batch is closed. Note: the Host accepts two or more transactions with the same TransactionNumber, but the last transaction will overwrite any previous transactions. For example, if a Sale is performed for TransactionNumber 1 and then a Credit is performed, only the Credit will post to the cardholder's account (it will be as if the Sale transaction never happened, with the exception of the reserved funds).

This property is not applicable for the ottRevise and ottVoid transaction types. Thus when GetDetailAggregate is called, the returned aggregate will contain the TransactionNumber specified within the original transaction.

Below is a table of the various transaction types and how TransactionNumber should be handled for Credit Card transactions. Note that the below table is only applicable to Credit Card transactions.

Debit/EBT cards are always performed online and thus each successful transaction should have their own unique TransactionNumber that starts at 999 and decrements by 1 for each success transaction performed.

URL Property (FDMSOmahaRetail 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.

Note: This property is only applicable when TransportProtocol is set to '0' (Datawire).

VisaIdentifier Property (FDMSOmahaRetail Component)

Additional merchant identification field used when authorizing Visa transactions.

Syntax

• C#
• VB.NET

public string VisaIdentifier { get; set; }

Public Property VisaIdentifier As String

Default Value

""

Remarks

In conjunction with Visa regulatory change(s), First Data will require the Agent Identification Service from all Third Party Servicers (TPS) or Merchant Servicers (MS). This information should be passed for all card types. Each 17-byte Visa Agent Identifier in the chain is composed of the following pieces:

AuthOnly Method (FDMSOmahaRetail Component)

Sends an Authorization Only request.

Syntax

• C#
• VB.NET

public void AuthOnly();

Public Sub AuthOnly()

Remarks

This method sends an authorization only request to the FDMS transaction processor, which reserves funds from the Cardholder's available credit (Open to Buy amount). The EntryDataSource field determines whether Track1, Track2, or manually entered card and expiration date are sent in the request. If the authorization request was successful, Success will be True.

An authorization blocks funds on the customer's credit card, but does not actually transfer funds. In order for funds to be transferred and the transaction completed, you must settle the transaction. To do this, you must pass an XML aggregate containing the results of the transaction to the OmahaDetailRecord component. You will then need to set the BatchNumber, TransactionNumber, and TransactionType to ttCapture. The DetailAggregate can then be added to the DetailRecords collection of the BatchMgr component to be used when the batch is closed. OmahaRetail.Card.MagneticStripe = "B4444333322221111^SMITH/JOHN M ^031210100000033301000000008000000"; OmahaRetail.Card.EntryDataSource = edsTrack1; OmahaRetail.AuthOnly() if (OmahaRetail.Response.Success) { OmahaDetailRecord.ParseAggregate(OmahaRetail.GetDetailAggregate()); OmahaDetailRecord.BatchNumber = 1; OmahaDetailRecord.TransactionNumber = 1; OmahaDetailRecord.TransactionType = ttCapture; OmahaBatchMgr.DetailRecords.Add(new OmahaRecordType(OmahaDetailRecord.GetDetailAggregate())); } 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.

Config Method (FDMSOmahaRetail 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.

DebitRefund Method (FDMSOmahaRetail Component)

Sends a Refund request for a Debit or EBT card.

Syntax

• C#
• VB.NET

public void DebitRefund();

Public Sub DebitRefund()

Remarks

This method sends a Debit/EBT refund (return) request to the FDMS transaction processor, which returns funds to a Cardholder's account. If the Refund request was successful, Success will be True.

For Debit Card refunds, Track2 data will need to be set as well as the DebitKSN and DebitPIN.

For EBT transactions, EBTPaymentType will need to be set as well as the Track2 card data or card number, DebitKSN and DebitPIN. For Food Stamp Voucher transactions, you will need to set EBTVoucherCode and EBTVoucherNumber rather than DebitKSN and DebitPIN. OmahaRetail.TransactionNumber = 999; OmahaRetail.TransactionAmount = "1.00"; OmahaRetail.Card.EntryDataSource = edsTrack2; OmahaRetail.Card.MagneticStripe = "4017779999999999=16041200000000001"; OmahaRetail.DebitKSN = "876543210A005611119"; OmahaRetail.DebitPIN = "8741F3581F20D1D1"; OmahaRetail.DebitRefund(); if (OmahaRetail.ResponseSuccess) { OmahaBatchMgr.DetailRecords.Add(new OmahaRecordType(OmahaRetail.GetDetailAggregate())); } 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.

DebitVoidTransaction Method (FDMSOmahaRetail Component)

Sends a void request for a previous debit card transaction.

Syntax

• C#
• VB.NET

public void DebitVoidTransaction(string detailAggregate);

Public Sub DebitVoidTransaction(ByVal DetailAggregate As String)

Remarks

This method is used to void a Debit Card transaction.

DetailAggregate is the full detail aggregate returned by a GetDetailAggregate call for a Debit Card transaction. FDMSOmahaRetail.DebitVoidTransaction(FDMSOmahaRetail.GetDetailAggregate());

EBTBalanceInquiry Method (FDMSOmahaRetail Component)

Sends a Balance Inquiry request for EBT.

Syntax

• C#
• VB.NET

public void EBTBalanceInquiry();

Public Sub EBTBalanceInquiry()

Remarks

This method sends an EBT Balance Inquiry request to the FDMS transaction processor, which returns the account balance via Balance. If the Balance Inquiry request was successful, Success will be True.

OmahaRetail.Card.EntryDataSource = edsManualEntryTrack2Capable; OmahaRetail.Card.Number = "5076899999999999"; OmahaRetail.Card.ExpMonth = 12; OmahaRetail.Card.ExpYear = 2049; OmahaRetail.DebitKSN = "876543210A005611119"; OmahaRetail.DebitPIN = "8741F3581F20D1D1"; OmahaRetail.EBTBalanceInquiry();

EBTCashWithdrawal Method (FDMSOmahaRetail Component)

Sends a withdrawal request for EBT Cash Benefit cards.

Syntax

• C#
• VB.NET

public void EBTCashWithdrawal();

Public Sub EBTCashWithdrawal()

Remarks

This method sends a withdrawal (cash only) request to the FDMS transaction processor for the amount specified within DebitCashBackAmount. This method is only available for EBT Cash Benefit cards (when EBTPaymentType is set to etCashBenefits). If the Cash Withdrawal request was successful, Success will be True. OmahaRetail.EBTPaymentType = etCashBenefits; OmahaRetail.Card.EntryDataSource = edsManualEntryTrack2Capable; OmahaRetail.Card.Number = "5076899999999999"; OmahaRetail.Card.ExpMonth = 12; OmahaRetail.Card.ExpYear = 2049; OmahaRetail.DebitKSN = "876543210A005611119"; OmahaRetail.DebitPIN = "8741F3581F20D1D1"; OmahaRetail.TransactionAmount = "5.00"; OmahaRetail.EBTCashWithdrawal();

GetDetailAggregate Method (FDMSOmahaRetail 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 FDMSOmahaBatchMgr 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 FDMSOmahaDetailRecord component to do so.

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

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

OmahaRetail.AuthOnly() if (OmahaRetail.Response.Success) { OmahaDetailRecord.ParseDetailRecord(OmahaRetail.GetDetailAggregate()); }

Interrupt Method (FDMSOmahaRetail 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.

OnlineRefund Method (FDMSOmahaRetail Component)

Sends a Refund request for a Visa/Visa Electron Credit card.

Syntax

• C#
• VB.NET

public void OnlineRefund();

Public Sub OnlineRefund()

Remarks

This method sends a Visa Credit Card Refund (Return) request to the FDMS transaction processor, which returns funds to a Cardholder's account. If the Refund request was successful, Success will be True.

The EntryDataSource field determines whether Track1, Track2, or manually entered card and expiration date are sent in the request. OmahaRetail.TransactionNumber = 999; OmahaRetail.TransactionAmount = "1.00"; OmahaRetail.Card.EntryDataSource = edsTrack2; OmahaRetail.Card.MagneticStripe = "4017779999999999=16041200000000001"; OmahaRetail.OnlineRefund(); if (OmahaRetail.ResponseSuccess) { OmahaBatchMgr.DetailRecords.Add(new OmahaRecordType(OmahaRetail.GetDetailAggregate())); } 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.

Reset Method (FDMSOmahaRetail 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.

Sale Method (FDMSOmahaRetail Component)

Sends a sale request for Credit, Debit, and EBT cards. Authorizes a credit card using track1, track2, or manually entered card data.

Syntax

• C#
• VB.NET

public void Sale();

Public Sub Sale()

Remarks

This method sends a sale (authorize and capture) request to the FDMS transaction processor. The EntryDataSource field determines whether Track1, Track2, or a manually entered card and expiration date are sent in the request. If the Sale request was successful, Success will be True.

For Debit Card sales, Track2 data will need to be set as well as the DebitKSN and DebitPIN.

For EBT transactions, EBTPaymentType will need to be set as well as the DebitKSN and DebitPIN. For Food Stamp Voucher transactions, you will need to set EBTVoucherCode and EBTVoucherNumber rather than DebitKSN and DebitPIN.

After a successful sale, the DetailAggregate can then be added to the DetailRecords collection of the BatchMgr component to be used when the batch is closed. OmahaRetail.Card.MagneticStripe = "B4444333322221111^SMITH/JOHN M ^031210100000033301000000008000000"; OmahaRetail.Card.EntryDataSource = edsTrack1; OmahaRetail.BatchNumber = 1; OmahaRetail.TransactionNumber = 1; OmahaRetail.Sale() if (OmahaRetail.Response.Success) { OmahaBatchMgr.DetailRecords.Add(new OmahaRecordType(OmahaRetail.GetDetailAggregate())); } 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.

SaleVoid Method (FDMSOmahaRetail Component)

Sends an Online Void request for a previous Credit Card Sale transaction.

Syntax

• C#
• VB.NET

public void SaleVoid(string detailAggregate);

Public Sub SaleVoid(ByVal DetailAggregate As String)

Remarks

This method is used to do an Online Void of a Credit Card Sale transaction.

DetailAggregate is the full detail aggregate returned by a GetDetailAggregate call for a Credit Card transaction. FDMSOmahaRetail.SaleVoid(FDMSOmahaRetail.GetDetailAggregate());

Connected Event (FDMSOmahaRetail 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, FdmsomaharetailConnectedEventArgs e);

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

Public Event OnConnected As OnConnectedHandler

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

Public Class FdmsomaharetailConnectedEventArgs 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.

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

DataPacketIn Event (FDMSOmahaRetail 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, FdmsomaharetailDataPacketInEventArgs e);

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

Public Event OnDataPacketIn As OnDataPacketInHandler

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

Public Class FdmsomaharetailDataPacketInEventArgs 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 (FDMSOmahaRetail 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, FdmsomaharetailDataPacketOutEventArgs e);

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

Public Event OnDataPacketOut As OnDataPacketOutHandler

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

Public Class FdmsomaharetailDataPacketOutEventArgs 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 (FDMSOmahaRetail Component)

This event is fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

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

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

Public Event OnDisconnected As OnDisconnectedHandler

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

Public Class FdmsomaharetailDisconnectedEventArgs 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.

Note: This event is not fired when TransportProtocol is set to '1' (VPN Connection).

Error Event (FDMSOmahaRetail 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, FdmsomaharetailErrorEventArgs e);

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

Public Event OnError As OnErrorHandler

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

Public Class FdmsomaharetailErrorEventArgs 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 (FDMSOmahaRetail 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, FdmsomaharetailSSLServerAuthenticationEventArgs e);

public class FdmsomaharetailSSLServerAuthenticationEventArgs : 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 FdmsomaharetailSSLServerAuthenticationEventArgs)

Public Class FdmsomaharetailSSLServerAuthenticationEventArgs 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 (FDMSOmahaRetail Component)

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

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

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

Public Event OnSSLStatus As OnSSLStatusHandler

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

Public Class FdmsomaharetailSSLStatusEventArgs 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 (FDMSOmahaRetail Component)

Shows the progress of the FDMS/Datawire connection.

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

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

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

Public Event OnStatus As OnStatusHandler

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

Public Class FdmsomaharetailStatusEventArgs 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.

Note: This event is not fired when TransportProtocol is set to '1' (VPN 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.

FDMSOmahaResponse Type

Contains the response to the authorization.

Remarks

This type contains the results of a transaction made with the FDMSOmahaECommerce, FDMSOmahaRetail or FDMSOmahaRestaurant component. The fields contained by this type are listed below.

Fields

Constructors

• C#
• VB.NET

public FDMSOmahaResponse();

Public FDMSOmahaResponse()

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

FDMSOmahaRetail Config Settings

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

FDMSOmahaRetail 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