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
TibcFDMSOmahaRetail
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.
ApplicationId | Identifies the merchant application to the Datawire System. |
BatchNumber | Number identifying the batch (assigned by the POS device). |
Card | Contains the customer's credit card information. |
ClientRef | Uniquely identifies the transaction within the Datawire system. |
CustomerCode | Merchant-assigned customer code. |
DatawireId | Identifies the merchant to the Datawire System. |
DebitCashBackAmount | Optional cash back amount to return to the customer. |
DebitKSN | Clear-text Key Sequence Number, used for Debit and EBT transactions. |
DebitPIN | DUKPT DES encrypted PIN block, used for Debit and EBT transactions. |
DeviceId | POS Device Identification. |
EBTPaymentType | Indicates the type of EBT transaction to process. |
EBTVoucherCode | Used to clear (force) a Food Stamp Voucher that was previously voice-authorized. |
EBTVoucherNumber | Used to clear (force) a Food Stamp Voucher that was previously voice-authorized. |
InvoiceNumber | Merchant-defined invoice number. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MerchantNumber | A unique number used to identify the merchant within the FDMS systems. |
MerchantTerminalID | Used to identify a unique terminal within a merchant location. |
OperatorID | Merchant-assigned operator code identifying the operator who entered the transaction. |
OrderNumber | Merchant-defined number identifying the purchase or service. |
Proxy | A set of properties related to proxy access. |
RemoteHost | This property includes the address of the remote host. Domain names are resolved to IP addresses. |
RemotePort | This property includes the Transmission Control Protocol (TCP) port in the remote host. |
Response | Contains the response to an authorization request. |
ShipToZipCode | The zip code where the purchased items will be shipped to. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SurchargeAmount | Dollar-and-cent amount of the charge for the purchase. |
TaxAmount | Dollar-and-cent amount of tax for the purchase. |
Timeout | A timeout for the component. |
TPPID | Third Party Processor Identifier assigned by FDMS. |
TransactionAmount | Purchase amount to be charged to the cardholders account. |
TransactionNumber | The transaction number for the current transaction. |
URL | Location of the Datawire server to which transactions are sent. |
VisaIdentifier | Additional merchant identification field used when authorizing Visa transactions. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AuthOnly | Sends an Authorization Only request. |
Config | Sets or retrieves a configuration setting. |
DebitRefund | Sends a Refund request for a Debit or EBT card. |
DebitVoidTransaction | Sends a void request for a previous debit card transaction. |
EBTBalanceInquiry | Sends a Balance Inquiry request for EBT. |
EBTCashWithdrawal | Sends a withdrawal request for EBT Cash Benefit cards. |
GetDetailAggregate | Returns an aggregate containing details of this transaction, which is then used for settlement. |
Interrupt | Interrupts the current action. |
OnlineRefund | Sends a Refund request for a Visa/Visa Electron Credit card. |
Reset | Clears all properties to their default values. |
Sale | Sends a sale request for Credit, Debit, and EBT cards. Authorizes a credit card using track1, track2, or manually entered card data. |
SaleVoid | Sends an Online Void request for a previous Credit Card Sale transaction. |
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.
Connected | This event is fired immediately after a connection completes (or fails). |
DataPacketIn | Fired when receiving a data packet from the transaction server. |
DataPacketOut | Fired when sending a data packet to the transaction server. |
Disconnected | This event is fired when a connection is closed. |
Error | Fired when information is available about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Status | Shows the progress of the FDMS/Datawire connection. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
ACI | Requested Authorization Characteristics Indicator (ACI). |
AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
AuthorizationIndicator | MasterCard Final Authorization Indicator. |
CITMITIndicator | CIT/MIT Indicator. |
CustomerAddress | The customer's street number of the billing address. |
CustomerZip | Customer's zip code (or postal code if outside of the USA). |
DebitItemNumber | Debit Item Number (the next available TransactionNumber for a Debit/EBT transaction). |
GiftCardIndicator | Gift Card Indicator. Amex only. |
IsPrepaidCard | Indicates that the specified card is a prepaid card. |
MITIndicator | Indicator used to identify the Merchant Initiated Transactions. |
MITTransactionId | Transaction Identifier from the original authorization response. It is required when sending a Merchant Initiated Sale transaction or Merchant Initiated AuthOnly transaction. |
POSConditionCode | The POS condition code. |
ResponseNetworkName | The name of the authorization network. |
ResponseRoutingCode | The routing code response. |
ResponseSignatureCode | The signature code response. |
TerminalCapabilities | The list of capabalities available for the terminal. |
TerminalCardCapability | The terminal's card capture capability. |
TerminalCategoryCode | A 1-character value used to identify the POS terminal type. |
TerminalPinCapability | The terminal's PIN capability. |
TransportProtocol | Specifies the transport protocol to use to communicate with the FDMS Omaha server. |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
ApplicationId Property (FDMSOmahaRetail Component)
Identifies the merchant application to the Datawire System.
Syntax
property ApplicationId: String read get_ApplicationId write set_ApplicationId;
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
property BatchNumber: Integer read get_BatchNumber write set_BatchNumber;
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
property Card: TibcCCCard read get_Card write set_Card;
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.
Please refer to the CCCard type for a complete list of fields.ClientRef Property (FDMSOmahaRetail Component)
Uniquely identifies the transaction within the Datawire system.
Syntax
property ClientRef: String read get_ClientRef write set_ClientRef;
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
property CustomerCode: String read get_CustomerCode write set_CustomerCode;
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
property DatawireId: String read get_DatawireId write set_DatawireId;
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
property DebitCashBackAmount: String read get_DebitCashBackAmount write set_DebitCashBackAmount;
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
property DebitKSN: String read get_DebitKSN write set_DebitKSN;
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
property DebitPIN: String read get_DebitPIN write set_DebitPIN;
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
property DeviceId: String read get_DeviceId write set_DeviceId;
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
property EBTPaymentType: TibcOmahaEBTPaymentTypes read get_EBTPaymentType write set_EBTPaymentType;
TibcOmahaEBTPaymentTypes = ( etNotApplicable, etFoodStamps, etCashBenefits );
Default Value
etNotApplicable
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.
etNotApplicable (0) | Payment is not being made with an EBT card (used for Credit or Debit card transactions). |
etFoodStamps (1) | Payment is made with a Food Stamps card. |
etCashBenefits (2) | Payment is made with a Cash Benefits card. |
EBTVoucherCode Property (FDMSOmahaRetail Component)
Used to clear (force) a Food Stamp Voucher that was previously voice-authorized.
Syntax
property EBTVoucherCode: String read get_EBTVoucherCode write set_EBTVoucherCode;
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
property EBTVoucherNumber: String read get_EBTVoucherNumber write set_EBTVoucherNumber;
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
property InvoiceNumber: String read get_InvoiceNumber write set_InvoiceNumber;
Default Value
''
Remarks
This property is used to specify an invoice number as defined by the merchant.
The maximum length of this property 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
property LocalHost: String read get_LocalHost write set_LocalHost;
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
property LocalPort: Integer read get_LocalPort write set_LocalPort;
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
property MerchantNumber: String read get_MerchantNumber write set_MerchantNumber;
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
property MerchantTerminalID: String read get_MerchantTerminalID write set_MerchantTerminalID;
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
property OperatorID: String read get_OperatorID write set_OperatorID;
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
property OrderNumber: String read get_OrderNumber write set_OrderNumber;
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
property Proxy: TibcProxy read get_Proxy write set_Proxy;
Remarks
This property contains fields describing the proxy through which the component will attempt to connect.
Please refer to the Proxy type for a complete list of fields.RemoteHost Property (FDMSOmahaRetail Component)
This property includes the address of the remote host. Domain names are resolved to IP addresses.
Syntax
property RemoteHost: String read get_RemoteHost write set_RemoteHost;
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
property RemotePort: Integer read get_RemotePort write set_RemotePort;
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
property Response: TibcFDMSOmahaResponse read get_Response;
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:
AuthCode | The Authorization Code returned from the server after a successful transaction authorization. |
AuthorizedAmount | When supporting partial authorizations, this is the amount actually charged to the credit card. |
AVSResult | Contains the Address Verification System result code. |
Balance | Contains the remaining available balance left on the card. |
BatchNumber | Number identifying the batch assigned by the POS device. |
CommercialCard | Indicates whether the credit card charged is a corporate commercial card. |
CVVResult | Contains the returned CVV result code (if CVV data was sent in the request). |
DebitNetworkName | The name of the network through which the debit card was processed. |
DebitNetworkNumber | The number of the debit network through which the debit card was processed. |
EBTResponseCode | The response code sent by the network that processed the transaction. |
RequestedAmount | The amount entered at the Point of Sale device to be authorized. |
ReturnedACI | Returned Authorization Characteristics Indicator contains CPS qualification status. |
RevisionNumber | Revision number of the online transaction. |
Success | Determines whether the transaction was successful. |
Text | Message from the Host describing the transaction. |
TransactionId | Contains the Transaction Identifier or MasterCard Reference Number. |
TransactionNumber | Number of the transaction in the batch as specified by the Point of Sale device. |
This property is read-only.
Please refer to the FDMSOmahaResponse type for a complete list of fields.ShipToZipCode Property (FDMSOmahaRetail Component)
The zip code where the purchased items will be shipped to.
Syntax
property ShipToZipCode: String read get_ShipToZipCode write set_ShipToZipCode;
Default Value
''
Remarks
This property 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.
SSLAcceptServerCertEncoded Property (FDMSOmahaRetail Component)
This is the certificate (PEM/Base64 encoded).
Syntax
property SSLAcceptServerCertEncoded: String read get_SSLAcceptServerCertEncoded write set_SSLAcceptServerCertEncoded; property SSLAcceptServerCertEncodedB: TBytes read get_SSLAcceptServerCertEncodedB write set_SSLAcceptServerCertEncodedB;
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
This property is not available at design time.
SSLCertEncoded Property (FDMSOmahaRetail Component)
This is the certificate (PEM/Base64 encoded).
Syntax
property SSLCertEncoded: String read get_SSLCertEncoded write set_SSLCertEncoded; property SSLCertEncodedB: TBytes read get_SSLCertEncodedB write set_SSLCertEncodedB;
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
This property is not available at design time.
SSLCertStore Property (FDMSOmahaRetail Component)
This is the name of the certificate store for the client certificate.
Syntax
property SSLCertStore: String read get_SSLCertStore write set_SSLCertStore; property SSLCertStoreB: TBytes read get_SSLCertStoreB write set_SSLCertStoreB;
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.
Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
SSLCertStorePassword Property (FDMSOmahaRetail Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
property SSLCertStorePassword: String read get_SSLCertStorePassword write set_SSLCertStorePassword;
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType Property (FDMSOmahaRetail Component)
This is the type of certificate store for this certificate.
Syntax
property SSLCertStoreType: TibcCertStoreTypes read get_SSLCertStoreType write set_SSLCertStoreType;
TibcCertStoreTypes = ( cstUser, cstMachine, cstPFXFile, cstPFXBlob, cstJKSFile, cstJKSBlob, cstPEMKeyFile, cstPEMKeyBlob, cstPublicKeyFile, cstPublicKeyBlob, cstSSHPublicKeyBlob, cstP7BFile, cstP7BBlob, cstSSHPublicKeyFile, cstPPKFile, cstPPKBlob, cstXMLFile, cstXMLBlob, cstJWKFile, cstJWKBlob, cstSecurityKey, cstBCFKSFile, cstBCFKSBlob, cstPKCS11, cstAuto );
Default Value
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SSLCertSubject Property (FDMSOmahaRetail Component)
This is the subject of the certificate used for client authentication.
Syntax
property SSLCertSubject: String read get_SSLCertSubject write set_SSLCertSubject;
Default Value
''
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
SSLProvider Property (FDMSOmahaRetail Component)
This specifies the SSL/TLS implementation to use.
Syntax
property SSLProvider: TibcTSSLProviders read get_SSLProvider write set_SSLProvider;
TibcTSSLProviders = ( sslpAutomatic, sslpPlatform, sslpInternal );
Default Value
sslpAutomatic
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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
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.
SSLServerCertEncoded Property (FDMSOmahaRetail Component)
This is the certificate (PEM/Base64 encoded).
Syntax
property SSLServerCertEncoded: String read get_SSLServerCertEncoded; property SSLServerCertEncodedB: TBytes read get_SSLServerCertEncodedB;
Default Value
''
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
This property is read-only and not available at design time.
SurchargeAmount Property (FDMSOmahaRetail Component)
Dollar-and-cent amount of the charge for the purchase.
Syntax
property SurchargeAmount: String read get_SurchargeAmount write set_SurchargeAmount;
Default Value
''
Remarks
This property 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
property TaxAmount: String read get_TaxAmount write set_TaxAmount;
Default Value
''
Remarks
This property 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
property Timeout: Integer read get_Timeout write set_Timeout;
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
property TPPID: String read get_TPPID write set_TPPID;
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
property TransactionAmount: String read get_TransactionAmount write set_TransactionAmount;
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
property TransactionNumber: Integer read get_TransactionNumber write set_TransactionNumber;
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.
Credit Card Transaction Type | TransactionNumber Handling |
AuthOnly | TransactionNumber = 0 (This is the case for all AuthOnly transactions). |
Sale | Last TransactionNumber + 1 |
Capture | Last TransactionNumber + 1 |
Refund | Last TransactionNumber + 1 |
Revise | Not applicable as the TransactionNumber contained within the DetailAggregate is used. |
Void | Not applicable as the TransactionNumber contained within the DetailAggregate is used. |
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.
Debit/EBT Card Transaction Type | TransactionNumber Handling |
All | Last TransactionNumber - 1 |
URL Property (FDMSOmahaRetail Component)
Location of the Datawire server to which transactions are sent.
Syntax
property URL: String read get_URL write set_URL;
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
property VisaIdentifier: String read get_VisaIdentifier write set_VisaIdentifier;
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:
First 5 bytes: | Visa Business Identifier (Bid) |
Final 12 bytes: | Text representation of the hexadecimal Visa secret Agent Unique Account Result (AUAR).. {0x01, 0x02, 0x03, 0x04, 0x05, 0xFF} will be represented as "0102030405FF". |
AuthOnly Method (FDMSOmahaRetail Component)
Sends an Authorization Only request.
Syntax
procedure 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 property 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.CardMagneticStripe = "B4444333322221111^SMITH/JOHN M ^031210100000033301000000008000000"
OmahaRetail.CardEntryDataSource = edsTrack1
OmahaRetail.AuthOnly()
if (OmahaRetail.ResponseSuccess) {
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
function Config(ConfigurationString: String): 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
procedure 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
procedure DebitVoidTransaction(DetailAggregate: 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
procedure 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
procedure 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
function GetDetailAggregate(): 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 raises an exception.
An example of how this method is used is shown below:
OmahaRetail.AuthOnly()
If (OmahaRetail.ResponseSuccess = True) Then
OmahaDetailRecord.ParseDetailRecord(OmahaRetail.GetDetailAggregate())
End If
Interrupt Method (FDMSOmahaRetail Component)
Interrupts the current action.
Syntax
procedure 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
procedure 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 property 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
procedure 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
procedure Sale();
Remarks
This method sends a sale (authorize and capture) request to the FDMS transaction processor. The EntryDataSource property 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.CardMagneticStripe = "B4444333322221111^SMITH/JOHN M ^031210100000033301000000008000000"
OmahaRetail.CardEntryDataSource = edsTrack1
OmahaRetail.BatchNumber = 1
OmahaRetail.TransactionNumber = 1
OmahaRetail.Sale()
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.
SaleVoid Method (FDMSOmahaRetail Component)
Sends an Online Void request for a previous Credit Card Sale transaction.
Syntax
procedure SaleVoid(DetailAggregate: 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
type TConnectedEvent = procedure ( Sender: TObject; StatusCode: Integer; const Description: String ) of Object;
property OnConnected: TConnectedEvent read FOnConnected write FOnConnected;
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
type TDataPacketInEvent = procedure ( Sender: TObject; DataPacket: String; DataPacketB: TBytes ) of Object;
property OnDataPacketIn: TDataPacketInEvent read FOnDataPacketIn write FOnDataPacketIn;
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
type TDataPacketOutEvent = procedure ( Sender: TObject; DataPacket: String; DataPacketB: TBytes ) of Object;
property OnDataPacketOut: TDataPacketOutEvent read FOnDataPacketOut write FOnDataPacketOut;
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
type TDisconnectedEvent = procedure ( Sender: TObject; StatusCode: Integer; const Description: String ) of Object;
property OnDisconnected: TDisconnectedEvent read FOnDisconnected write FOnDisconnected;
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
type TErrorEvent = procedure ( Sender: TObject; ErrorCode: Integer; const Description: String ) of Object;
property OnError: TErrorEvent read FOnError write FOnError;
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises 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
type TSSLServerAuthenticationEvent = procedure ( Sender: TObject; CertEncoded: String; CertEncodedB: TBytes; const CertSubject: String; const CertIssuer: String; const Status: String; var Accept: Boolean ) of Object;
property OnSSLServerAuthentication: TSSLServerAuthenticationEvent read FOnSSLServerAuthentication write FOnSSLServerAuthentication;
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
type TSSLStatusEvent = procedure ( Sender: TObject; const Message: String ) of Object;
property OnSSLStatus: TSSLStatusEvent read FOnSSLStatus write FOnSSLStatus;
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
type TStatusEvent = procedure ( Sender: TObject; const Message: String ) of Object;
property OnStatus: TStatusEvent read FOnStatus write FOnStatus;
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 raises an exception because none is present.
Fields
CardType
TibcTCardTypes
Default Value: 0
Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the Number is set, but it can also be changed manually. A list of valid card types is included below.
ctUnknown (0) | Invalid or unknown prefix, card type not known. |
ctVisa (1) | Visa or Delta Card. |
ctMasterCard (2) | MasterCard. |
ctAMEX (3) | American Express Card. |
ctDiscover (4) | Discover Card. |
ctDiners (5) | Diners Club or Carte Blanche Card. |
ctJCB (6) | JCB Card. |
ctVisaElectron (7) | Visa Electron Card (runs as a Visa for most gateways) |
ctMaestro (8) | Maestro Card |
ctLaser (10) | Laser Card (Ireland) |
CVVData
String
Default Value: ""
Three digit security code on back of card (optional).
This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.
Even if the CVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.
Note: When set to a non-empty value, CVVPresence will be automatically set to cvpProvided. If set to empty string (""), CVVPresence will be automatically set to cvpNotProvided.
CVVPresence
TibcCCCVVPresences
Default Value: 0
Indicates the presence of the card verification value.
This property is used to indicate the presence of CVVData.
The component will automatically set this value to cvpProvided when a CVVData value is specified. You can explicitly specify the CVVPresence indicator by setting this property.
Available values are:
- cvpNotProvided (0)
- cvpProvided (1)
- cvpIllegible (2)
- cvpNotOnCard (3)
EntryDataSource
TibcEntryDataSources
Default Value: 0
This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.
edsTrack1 (0) | Full Magnetic stripe read and transmit, Track 1. |
edsTrack2 (1) | Full magnetic stripe read and transmit, Track 2. |
edsManualEntryTrack1Capable (2) | Manually keyed, Track 1 capable. |
edsManualEntryTrack2Capable (3) | Manually keyed, Track 2 capable. |
edsManualEntryNoCardReader (4) | Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions). |
edsTrack1Contactless (5) | Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only). |
edsTrack2Contactless (6) | Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only). |
edsManualEntryContactlessCapable (7) | Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only). |
edsIVR (8) | Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (Number, ExpMonth, and ExpYear are sent). |
edsKiosk (9) | Automated kiosk transaction. Track1 or Track2 data must be sent in MagneticStripe, the transaction cannot be manually entered. |
Below is a list of processors and their support EntryDataSource values:
FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk
FDMSOmaha - All EntryDataSources applicable
FDMS Rapid Connect - All EntryDataSources applicable
Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk
PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable
TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable
TSYSHC - Values are based on Industry type.
TSYSHCBenefit | edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable |
TSYSHCECommerce | edsManualEntryNoCardReader |
TSYSHCRetail | edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable |
ExpMonth
Integer
Default Value: 1
Expiration month of the credit card specified in Number.
This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.
ExpYear
Integer
Default Value: 2000
Expiration year of the credit card specified in Number.
This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.
IsEncrypted
Boolean
Default Value: False
Determines whether data set to the Number or MagneticStripe fields is validated.
By default, when the Number or MagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and MagneticStripe data will be parsed for the track specified by EntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the Number or MagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.
MagneticStripe
String
Default Value: ""
Track data read off of the card's magnetic stripe.
If EntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the EntryDataSource property to indicate which track you are sending.
The following example shows how to set the MagneticStripe and EntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"
component.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
component.CardEntryDataSource = edsTrack1
or
component.CardMagneticStripe = "4788250000028291=05121015432112345678"
component.CardEntryDataSource = edsTrack2
Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.
Number
String
Default Value: ""
Customer's credit card number for the transaction.
If you're sending the transaction with MagneticStripe data, this property should be left empty.
Constructors
constructor Create();
constructor Create(valNumber: String; valExpMonth: Integer; valExpYear: Integer);
constructor Create(valMagneticStripe: String; valEntryDataSource: TibcEntryDataSources);
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
AuthCode
String (read-only)
Default Value: ""
The Authorization Code returned from the server after a successful transaction authorization.
Note: The value in this field is parsed from Text.
The value returned in this field is required to perform a Capture or when performing an AuthOnly VoidTransaction request.
AuthorizedAmount
String (read-only)
Default Value: ""
When supporting partial authorizations, this is the amount actually charged to the credit card.
This is only used when supporting partial authorizations. This will be less than the original TransactionAmount. You must collect the remainder via another form of payment, or Void the authorization if the customer does not have an additional form of payment.
AVSResult
String (read-only)
Default Value: ""
Contains the Address Verification System result code.
This one character field contains the Address Verification System (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the batch settlement. The valid AVS codes are listed in the table below.
Valid AVS Codes:
Code | Description |
0 | Address verification was not requested. |
A | Customer's address matches, zip does not. |
E | AVS error / Ineligible (not a mail/phone order) |
G | Address information not verified for international transaction. (Non-US Issuer does not participate). |
I | Ver Unavailable - Address information not verified for international transaction. |
M | Exact Match - Address match for international transaction. |
N | No match on customer's address or zip. |
R | Retry - Issuer system unavailable. |
S | Service not supported by issuer. |
U | Address information is unavailable. |
W | Whole nine digit zip matches, but the address does not. |
X | Exact AVS match, nine digit zip. |
Y | Exact AVS match, five digit zip. |
Z | Five digit zip matches, but the address does not. |
If supporting international transactions, six additional International Address Verification Service (IAVS) codes are introduced:
B | Street address match for international transaction. Postal code not verified due to incompatible formats (acquirer sent both street address and postal code). |
C | Street address and postal code not verified for international transaction due to incompatible formats (acquirer sent both street address and postal code). |
D | Street addresses and postal codes match for international transaction. |
I | Address information not verified for international transaction. |
M | Street addresses and postal codes match for international transaction. |
P | Postal codes match for international transaction. Street address not verified due to incompatible formats (acquirer sent both street address and postal code). |
Balance
String (read-only)
Default Value: ""
Contains the remaining available balance left on the card.
The balance amount is returned by the Issuer when AllowPartialAuths is set to '1' or '3' for Sale transactions.
In the case that the balance is negative, the balance amount will contain a "-" character.
BatchNumber
Integer (read-only)
Default Value: 0
Number identifying the batch assigned by the POS device.
CommercialCard
TibcOmahaCommercialCardTypes (read-only)
Default Value: 0
Indicates whether the credit card charged is a corporate commercial card. In some cases, additional data is required to be sent for the transaction to be processed as a commercial card.
The available values are:
Value | Description |
octNotCommercial (0) | Not a Commercial Card |
octReviseTax (1) | Commercial Card, Sales Tax required for Settlement, Revised transaction required. |
octReviseCode (2) | Commercial Card, Customer Code required for Settlement, Revised transaction required. |
octReviseTaxCode (3) | Commercial Card, Sales Tax and Customer Code Required for Settlement, Revised transaction required. |
octCommercial (4) | Commercial Card, Sales Tax and Customer Code Present, edit not required. |
Note when a octReviseTax, octReviseCode, or octReviseTaxCode response is received, the transaction must be revised specifying the requested information (either Sales Tax, Customer Code, or both) to qualify as a Level 2 transaction. Revising a transaction is accomplished via the FDMSOmahaDetailRecord component and setting the TransactionType to ottRevise.
CVVResult
String (read-only)
Default Value: ""
Contains the returned CVV result code (if CVV data was sent in the request).
If a CVV value was sent in the authorization, this property will contain the host returned Card Verification Value result code. The following is a list of current result codes:
M | CVV2 match. |
N | CVV2 no match. |
P | Not processed. |
S | Merchant has indicated that CVV2 is not present on card. |
U | Unknown, or Issuer does not participate. |
X | Server Provider did not respond (Default). |
DebitCardTypeNumber
String (read-only)
Default Value: ""
The number of the debit network through which the debit card was processed.
DebitNetwork
String (read-only)
Default Value: ""
The name of the network through which the debit card was processed.
EBTResponseCode
String (read-only)
Default Value: ""
The response code sent by the network that processed the transaction.
This field will contain the response code sent by the network that processed the EBT transaction.
The available response codes are:
Code | Description |
00 | Approved Transaction. |
12 | Invalid Transaction. |
13 | ReEnter Transaction. |
14 | ReEnter Transaction. Invalid Card Number. |
19 | ReEnter Transaction. Invalid Card Number. |
31 | Cannot Process. Call Customer Service. |
32 | Cannot Process. Invalid Card Number. |
41 | Cannot Process. Call Customer Service. |
43 | Cannot Process. Call Customer Service. |
50 | Balance Verified. |
52 | Cannot Process. Invalid Card Number. |
54 | Expired Card. |
55 | Invalid PIN Number. |
58 | Invalid Transaction. |
61 | Invalid Transaction. |
62 | Cannot Process. Invalid Transaction. |
75 | PIN Tries Exceeded. |
77 | Cannot Process. Invalid Card Number. |
90 | Cannot Process. Call Customer Service. |
91 | Host Not Available. |
93 | Cannot Process. Call Customer Service. |
96 | Cannot Process. Call Customer Service. |
E5 | Cannot Process. Call Customer Service. |
RequestedAmount
String (read-only)
Default Value: ""
The amount entered at the Point of Sale device to be authorized.
ReturnedACI
String (read-only)
Default Value: ""
Returned Authorization Characteristics Indicator contains CPS qualification status.
This one character field contains the returned Authorization Characteristics Indicator (ACI). This value provides information concerning the transaction's CPS qualification status.
The following is a list of all returned ACI values. Please note that many of these return values result from features not available in any of the currently supported Industry Types.
Value | Description |
" " | (Space) Authorization did not qualify as a Custom Payment Service transaction or the acquirer or merchant does not participate in Custom Payment Service (CPS). |
A | Normal qualified |
C | Qualified, customer-activated terminal |
E | Qualified Retail |
F | Card Not Present (Account Funding - with AVS and CVV2) |
K | Qualified CPS/Retail Key Entry (AVS is required with K) |
N | Not qualified |
U | Card Not Present (E-Commerce - 3D Secure) |
V | Qualified Address Verification (Card Not Present) |
W | Card Not Present (E-Commerce - Non 3D Secure w/AVS) |
RevisionNumber
Integer (read-only)
Default Value: 0
Revision number of the online transaction.
Success
Boolean (read-only)
Default Value: False
Determines whether the transaction was successful.
This field can be queried to determine whether the transaction was successful.
Text
String (read-only)
Default Value: ""
Message from the Host describing the transaction.
Below are some of the common message responses from the Host.
Value | Description |
APPROVED 999999 | The Host computer sends this response on an authorization-only transaction. The authorization code appears in place of the '999999'. |
AUTH/TKT 999999 | The Host computer sends this response on a sale transaction. The authorization code appears in place of the '999999'. |
PRTL SALE 999999 | The Host computer sends this response on a sale transaction when the transaction was only partially approved. The authorization code appears in place of the '999999'. |
BAL 999999.99 | This is the Host response to an EBT Balance Inquiry transaction. The '999999.99' represents the amount of the balance returned by the Network. |
CALL _CENTER | A condition exists with the cardholder account that requires special handling. The merchant must contact the Voice Authorization Center for instructions about how to proceed. |
CLOSE UNAVAIL | This is the Host response when the Host cannot accept the close batch message packet at that time. The merchant will need to retry the close at a later time. |
CLOSE 999999.99 | This is the Host response for a successful close transaction. The '999999.99' represents the batch amount for which the Host closed the batch. |
DECLINED | The issuer has declined the authorization of the transaction for one or more reasons. The merchant should accept another form of payment. |
DEP 999999.99 | This is the Host response to a deposit inquiry transaction. The '999999.99' represents the batch amount for which the Host closed the last batch. |
EXPIRED CARD | The expiration date sent with the authorization request indicates that the card has expired. |
INVALID EXP DATE | The expiration date sent with the authorization request was formatted incorrectly. |
FORCE 99999.99 | The Host closed the batch with an out-of-balance condition. The Host was unable to balance with the POS device. The merchant needs to contact the financial institution for assistance. |
INVALID AMOUNT | The POS device sends the Host an unacceptable dollar amount for authorization or the format of the number is incorrect. |
INV BATCH SEQ | The batch number of a transaction message (message packet) is out of sequence with the batch number the Host is expecting for the merchant number and device ID combination. This message can also appear if trying to post a transaction with a revision number that is less than or equal too the revision number already posted to the Host. |
INVLD BATCH SEQ | The batch number of a close batch message (message packet) is out of sequence with the batch number the Host is expecting for the merchant number and device ID combination. |
INVALID CARD # | The cardholder account number entered is not valid and is not acceptable for payment. The merchant must verify the cardholder account number. |
INVALID MRCH # | The merchant number in the transaction or close batch message is invalid or is not acceptable for the transaction code of the message packet being sent to the Host. |
INVALID PIN | The PIN entered by the cardholder is not valid. Attempt transaction again. |
CASH 999999 | The Host computer sends this response on an EBT Cash Withdrawal transaction. The authorization code appears in place of the '999999'. |
TransactionId
String (read-only)
Default Value: ""
Contains the Transaction Identifier or MasterCard Reference Number.
This 15-character property can contain a Transaction Identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field (if any) should be recorded and submitted in the Batch Settlement.
TransactionNumber
Integer (read-only)
Default Value: 0
Number of the transaction in the batch as specified by the Point of Sale device.
Constructors
constructor Create();
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
AuthScheme
TibcProxyAuthSchemes
Default Value: 0
This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the User and Password properties are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the component will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.
If AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of User and Password.
AutoDetect
Boolean
Default Value: False
This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is False.
Password
String
Default Value: ""
This property contains a password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.
Port
Integer
Default Value: 80
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server property for details.
Server
String
Default Value: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server property is set to the corresponding address. If the search is not successful, an error is returned.
SSL
TibcProxySSLTypes
Default Value: 0
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
User
String
Default Value: ""
This property contains a username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.
Constructors
constructor Create();
constructor Create(valServer: String; valPort: Integer);
constructor Create(valServer: String; valPort: Integer; valUser: String; valPassword: String);
Config Settings (FDMSOmahaRetail Component)
The component accepts one or more of the following configuration settings. Configuration 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.FDMSOmahaRetail Config Settings
I | Incremental Charge. |
P | Card is not present at time of the authorization request, but the cardholder is a preferred customer participant. |
R | Recurring Charge. |
Y | Card is present or the card is not present and request for address verification is needed. |
Possible values are:
1 | Accepts Partial Authorizations and Balance from Issuer |
2 | Does Not Accept Partial Authorizations for an Estimated Transaction Amount and Balance from Issuer |
3 | Accepts Partial Authorizations for an Estimated Transaction Amount and Balance from Issuer |
0 | Unknown Finality - The Settlement amount may be different than the amount authorized. This value applies when merchant has multiple authorizations using the same card, as in the case of incremental authorization. |
1 | Final Authorization - The Settlement amount must equal the approved authorized amount. |
Valid values are:
Customer Initiated Transaction (CIT)
Value | Description |
C101 | Credential on File |
C102 | Standing Order (variable amount, fixed frequency) |
C103 | Subscription (fixed amount and fixed frequency) |
C104 | Installment |
Merchant Initiated Transaction (MIT) - Recurring or Installment
Value | Description |
M101 | Unscheduled Credential on File |
M102 | Standing Order (variable amount, fixed frequency) |
M103 | Subscription (fixed amount and fixed frequency) |
M104 | Installment |
Merchant Initiated Transaction (MIT) - Industry Practice
Value | Description |
M205 | Partial Shipment |
M206 | Related/Delayed Charge |
M207 | No show Charge |
M208 | Resubmission |
The maximum length of this configuration setting is 5 characters.
The maximum length of this configuration setting is 9 characters.
For Credit Card transactions, the DebitItemNumber starts at 999 (provided it is not an AuthOnly transaction) and must decrement with each successful Debit/EBT transaction.
For Debit/EBT Card transactions, the DebitItemNumber is not required.
Valid values are:
Value | Description |
0 | Incremental Authorization (this is a continuation of the consumer purchase) |
1 | Resubmission (valid when the original authorization was declined for insufficient funds) |
2 | Delayed Charge (account charge associated with an agreement between a cardholder and a merchant for services rendered) |
3 | Reauthorization (purchase made after the original purchase such as: split shipment, estimated amount etc.) |
4 | No Show (when the customer did not meet the terms of the agreement and the merchant is able to charge for it) |
5 | Account Top Up |
C | Cardholder Credential Stored on File for subsequent transactions |
R | Recurring Transaction |
S | Customer Initiated COF subsequent transaction. |
U | Unscheduled Stored Credential MIT |
00 | Cardholder Present, Card Present |
01 | Cardholder Present, Unspecified |
02 | Cardholder Present, Unattended Device |
03 | Cardholder Present, Suspect Fraud |
04 | Cardholder Not Present - Recurring |
05 | Cardholder Present, Card Not Present |
06 | Cardholder Present, Identity Verified |
08 | Cardholder Not Present, Mail Order/Telephone Order |
59 | Cardholder Not Present, Ecommerce |
71 | Cardholder Present, Magnetic Stripe Could Not Be Read |
The list of available values for each position can be found below. To support multiple values in each position, each value should be ORed together using the binary OR operation. For example, in position 1 to support both Magstripe (1) and Manual Keyed (2) a value of 3 would be specified: 1 OR 2 = 3.
Position 1 values:
Value | Descriptiuon |
8 | Unknown |
4 | No Terminal Used - VRU |
2 | Manual Keyed |
1 | Magstripe |
0 | None |
Value | Descriptiuon |
8 | Contact Chip |
4 | Contactless Chip |
2 | Bar Code |
1 | OCR |
0 | None |
Value | Descriptiuon |
8 | Terminal Does Not Read Card Data |
4 | QR Code |
2 | Contactless MSD |
1 | Future Use |
0 | None |
Value | Descriptiuon |
8 | Future Use |
4 | Future Use |
2 | Future Use |
1 | Future Use |
0 | None |
0 | Terminal does not have the ability to transmit entire magnetic stripe information. |
9 | Terminal can transmit entire magnetic stripe information. |
Note: If set to 0 track data must not be specified.
0 | Unspecified |
1 | Limited amount terminal |
2 | Unattended terminal (ATM) |
3 | Unattended terminal (non ATM) |
4 | Electronic Cash Register (ECR) |
5 | Ecommerce customer present |
7 | Telephone device |
8 | Reserved |
9 | Mobile acceptance solution |
0 | Unspecified/Unknown |
1 | PIN entry capability |
2 | No PIN entry capability |
8 | PIN Pad Inoperative |
9 | Offline PIN verification (Discover only) |
0 (Default) | Datawire (HTTP) |
1 | VPN or PPP (TCP Connection) |
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
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 setting 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).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the component will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the component will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the component raises an exception.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to True tells the component to use the internal implementation instead of using the system security libraries.
This setting is set to False by default on all platforms.
Trappable Errors (FDMSOmahaRetail Component)
FDMSOmahaRetail Errors
432 Invalid index. | |
501 Invalid length for this property. | |
502 Invalid data format for this property. | |
503 Value is out of range. | |
504 Credit card digit check failed. | |
505 Card date invalid. | |
506 Card expired. | |
519 Corrupt response. | |
520 Response payload empty. | |
521 Response truncated. | |
526 Invalid timeout value. | |
593 A property required for this transaction is missing. | |
529 Error in XML response. | |
530 Status code received in response indicates an error condition. | |
531 Return code received in response indicates an error condition. | |
532 Cannot generate detail aggregate - this transaction was not successfully authorized. | |
533 Internal error constructing payload. |
The component may also return one of the following error codes, which are inherited from other components.
HTTP Errors
118 Firewall Error. Error description contains detailed message. | |
143 Busy executing current method. | |
151 HTTP protocol error. The error message has the server response. | |
152 No server specified in URL | |
153 Specified URLScheme is invalid. | |
155 Range operation is not supported by server. | |
156 Invalid cookie index (out of range). | |
301 Interrupted. | |
302 Can't open AttachedFile. |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the component is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
302 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |