FDMSGiftCard Configuration

This setting indicates the interval of time, in seconds, a client will wait for the response for any given request. Normally this value is set to a value 5 seconds less than the Timeout value to allow for a response to be received from Datawire. It may be changed independently by setting this configuration setting AFTER setting the Timeout property. Note that too small a value will cause Datawire to reject a transaction immediately.

This field contains a three digit number assigned by the signing member or processor to identify the merchant's authorization currency. For US Dollars, use "840".

If set to True the Status event will fire with the raw request and response information. This is helpful for debugging.

This setting is only used by the ActivateCard method. It allows you to activate the card, but the card will not be valid to use until the date specified in this setting. The format is MMDDYYYY.

This setting is only used by the ActivateCard method. It allows you to specify the date the gift card will expire. The format is MMDDYYYY.

This config is optional and can be used as the merchant sees fit. Data sent in this field is not checked and is sent back without any changes. This field is not stored on the database and will not appear on any reporting. The maximum length of the specified value is 26 characters.

To specify this is an online transaction rather than a card-present transaction, set the SourceCode to "00". When IsRetailTransaction is set to "False", a SourceCode value of "31" (Internet without EAN) will be sent if not explicitly specified.

This config is optional and can be used as the merchant sees fit. The maximum length of the specified value is 20 characters.

This config is optional and can be used as the merchant sees fit. The maximum length of the specified value is 20 characters.

This is an action config which when called sends a Refund transaction to add value back onto a card. A Refund differs from a LoadCard transaction in that the customer does not tender funds to provide the value. Typically this transaction is used for merchandise returns or unfulfilled orders where the card was previously charged.

When set to 'True' (the default value), the transaction will be performed in a retail environment and the retail transaction codes will be used. When set to 'False', the transaction will take place in an internet environment and the internet transaction codes will be used.

This is an action config which when called generates a private and public key pair to be used by the merchant when performing Internet transactions. The generated key pair will be returned via MerchantPrivateKey and MerchantPublicKey.

This config contains the Merchant's Private Key, that corresponds with the MerchantPublicKey, and is populated after a call to GenerateMerchantKeyPair is made. The returned key is a hex encoded. Note: The value should be securely stored in a safe location and *not* given to anyone. This config is also used when generating a working key via GenerateWorkingKey and thus can be set to a stored private key (must be a hex encoded version of the key).

This config contains the Merchant's Public Key, that corresponds with the MerchantPrivateKey, and is populated after a call to GenerateMerchantKeyPair is made. The returned key is a hex encoded. The created public key can be sent to FDMS to be assigned to your account and used as part of the encryption/decryption process when performing Internet based transactions.

This config is used to specify FDMS's Public Key which they will provide to you. This key is used when generating a working key via GenerateWorkingKey.

This is an action config which when called will generate a Merchant Working Key using the MerchantPrivateKey and FDMSPublicKey. The generated Working Key will be returned via DecryptedWorkingKey and EncryptedWorkingKey. These working keys are used when performing Internet based transactions and can be assigned to a merchant account via AssignMerchantWorkingKey.

This config is populated after a call to GenerateWorkingKey is made and contains the decrypted and hex encoded version of the generated Merchant Working Key. The returned value should be stored in a safe location as it is used to encrypt an EAN when performing an Internet based transaction.

This config is populated after a call to GenerateWorkingKey is made and contains the encrypted and hex encoded version of the generated Merchant Working Key. This config is also used to specify the working key to be sent in an AssignMerchantWorkingKey request.

This is an action config which when called sends an Assign Merchant Working Key request. When called the specified EncryptedWorkingKey will be assigned to the merchant account using the MerchantKeyID. This transaction is not paired with other transactions but rather is sent at the beginning of the program and periodically afterward. Note this request is only applicable to Internet transactions (when IsRetailTransaction is set to 'False').

This config is used to specify the ID associated with the EncryptedWorkingKey assigned to a merchant account. This value is used to specify an ID when assigning a merchant working key via a AssignMerchantWorkingKey request. Once a merchant key has been successfully assigned, the Key ID should be stored as it is used in subsequent Internet based transaction requests containing an EAN (it is used to perform the Encryption/Decryption). A Key ID must be numeric and cannot be longer than 4 digits in length.

This config is used to specify an extended account number (EAN) associated with the specified Card. The specified value will be encrypted, prior to being sent in the request, using the specified DecryptedWorkingKey. EAN values can be either 4 or 8 characters in length. Note: This field is only applicable to Internet based transactions (when IsRetailTransaction is 'False').

This config is used to specify an security card value (SCV) associated with the specified Card. This field cannot be used in conjunction with EAN. Note: This field is only applicable to Internet based transactions (when IsRetailTransaction is 'False').

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the control will use Timeout for establishing a connection and transmitting/receiving data.

This is the same as FirewallAutoDetect. This setting is provided for use by controls that do not directly expose Firewall properties.

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

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 is the same as FirewallHost. This setting is provided for use by controls that do not directly expose Firewall properties.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

NOTE: This is the same as FirewallPassword. This setting is provided for use by controls that do not directly expose Firewall properties.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This is the same as FirewallPort. This setting is provided for use by controls that do not directly expose Firewall properties.

The appropriate values are as follows:

NOTE: This is the same as FirewallFirewallType. This setting is provided for use by controls that do not directly expose Firewall properties.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the control fails with an error.

NOTE: This is the same as FirewallUser. This setting is provided for use by controls that do not directly expose Firewall properties.

When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Note: This value is not applicable in Java.

When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in Java or MAC.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires.

In the second scenario, 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 control returns control immediately, the system could hold system resources until all pending data is 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 (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout.

The LocalHost setting 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 control initiate connections (or accept in the case of server controls) only through that interface.

If the control 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).

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

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.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

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. The maximum value is 65536 bytes.

This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit.

If set to a positive value, this setting defines the length of data records to be received. The control will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

The default value is 0, meaning this setting is not used.

If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

When set to 0 (default), the control will use IPv4 exclusively. When set to 1, the control will use IPv6 exclusively. To instruct the control to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

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.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

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.

Used to enable/disable the supported security protocols.

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:

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Change this setting to use security providers other than the system default.

Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

This functionality is currently not available when the provider is OpenSSL.

This functionality is available only when the provider is OpenSSL.

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.

This functionality is available only when the provider is OpenSSL.

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.

This functionality is available only when the provider is OpenSSL.

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

This functionality is available only when the provider is OpenSSL.

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 AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

The default code page is the Active Code Page (0).

The following is a list of valid code page identifiers:

The following is a list of valid code page identifiers for Mac OS only: