GlobalDebit Component

Properties Methods Events Config Settings Errors

The GlobalDebit component is used to authorize debit card transactions with the Global Payments system, using the Global Transport Direct API. This component is supported in the Retail and Restaurant environments, and allows for simple, direct, secure communication to the Global Transport gateway through a standard Internet connection. This component can be integrated into Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

DPayments.DPaymentsSDK.GlobalDebit

Remarks

The GlobalDebit component contains a subset of the GlobalCharge component's functionality. It only authorizes debit card transactions in the Retail and Restaurant industries. It cannot be used for eCommerce accounts. This component provides a much simpler interface for processing debit cards (and only debit cards), but otherwise works much like the GlobalCharge component.

First, set the UserId and Password with your login information. If you're submitting test transactions and are using a test account, set the Server to the certification URL ("https://certapia.globalpay.com").

Next, set the MagneticStripe field with Track 2 data read off the card. PIN-based Debit card transactions cannot be manually entered, and are always card-present transactions. Sending Track 1 data in the MagneticStripe property will result in a failed transaction. You must also set the KSN and EncryptedPIN properties with data retrieved from the PIN pad after the customer enters their PIN.

Finally, set the TransactionAmount and if applicable, any CashBack amount. Then call Sale to send the transaction to the Global Transport Server for processing.

The result of the authorization request will be stored in the Response property. The Code field will contain the status of the request and the Text field will contain the human-readable response message. The contents of the Response should be logged after a successful transaction.

Debit card transactions are instant funds transfers. There is no block placed on the debit card, funds are immediately removed and sent to the merchant. Therefore, there is no ability to capture, void, or reverse debit transactions. You must use the Refund method to return funds to a customer's card. When performing a Refund, the MagneticStripe, EncryptedPIN, and KSN are required in addition to the PNRef parameter, which identifies the transaction you're issuing a refund for.

Property List

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


Card	Contains the customer's credit card information.
CashBack	Optional cash back amount to return to the customer.
CustomerName	The cardholder's name as it appears on the card.
EncryptedPIN	DUKPT DES encrypted pin block, retrieved from a PIN pad.
InvoiceNumber	Optional invoice tracking number.
KSN	Clear-text Key Serial Number retrieved from a PIN pad.
Password	Password for authentication with the Global Payments Server
Proxy	A set of properties related to proxy access.
RegisterNumber	A number that uniquely identifies the register or computer on which the transaction was performed.
Response	Contains the response to an EBT transaction.
Server	Global Payments transaction server.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
Timeout	The timeout for the component.
TransactionAmount	Amount to be charged from (or refunded to) the card.
UserId	UserId for authentication with the Global Payments Server .

Method List

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


Config	Sets or retrieves a configuration setting.
Interrupt	This method interrupts the current method.
Refund	Refunds a previous transaction.
Reset	Clears all properties to their default values.
Sale	Sends a Sale transaction to the host.

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.


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 Global Payments connection.

Config Settings

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


ContactOnly	Indicates if the POS device is only able to accept chip inserted EMV transactions.
EMVCapable	Indicates whether the Point of Sale is EMV enabled.
EMVData	The EMV data returned from a Pin Pad after reading an EMV card.
EMVEntryDataSource	The EMV Data Entry Source (DES).
PINCapable	Indicates if the POS device is capable of accepting PINs.
RawRequest	Returns the request sent to the server for debugging purposes.
RawResponse	Returns the response received from the server for debugging purposes.
ResponseEMVData	The response EMV data.
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).
FirewallListener	If true, the component binds to a SOCKS firewall as a server (TCPClient only).
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.
UseNTLMv2	Whether to use NTLM V2.
CACertFilePaths	The paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
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.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
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 certificates 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.
GUIAvailable	Whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

Card Property (GlobalDebit Component)

Contains the customer's credit card information.

public CCCard Card { get; set; }

Public Property Card As CCCard

Remarks

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

This property is not available at design time.

Please refer to the CCCard type for a complete list of fields.

CashBack Property (GlobalDebit Component)

Optional cash back amount to return to the customer.

Syntax

C#
VB.NET

public string CashBack { get; set; }

Public Property CashBack As String

Default Value

Remarks

For cash back transactions, the TransactionAmount must contain the sum total of the purchase amount PLUS the CashBack amount. If the purchase is for $10 and the customer requests $20 cash back, CashBack should be set to "20.00" and TransactionAmount must contain "30.00". This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

Note that only US currency is supported for debit and EBT cash benefit transactions.

CustomerName Property (GlobalDebit Component)

The cardholder's name as it appears on the card.

Syntax

C#
VB.NET

public string CustomerName { get; set; }

Public Property CustomerName As String

Default Value

Remarks

This optional field may contain up to 26 alphanumeric characters and symbols.

EncryptedPIN Property (GlobalDebit Component)

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

Syntax

C#
VB.NET

public string EncryptedPIN { get; set; }

Public Property EncryptedPIN As String

Default Value

Remarks

A 16-byte encrypted PIN and associated KSN (Key Serial/Sequence Number) are required for all debit Sale and Refund transactions. These values must be retrieved from a certified DUKPT DES pin pad device.

Debit transactions are only supported for Retail merchants, and only for Card Present transactions. If you set the UserId to an ID associated with a Direct Marketing or E-Commerce merchant account, or otherwise attempt a card-not-present transaction, the component throws an exception.

  Copy
  component.UserId = "4dpayments_retail";
  component.Password = "Passw0rd";  
  component.Card = new GlobalCard("9999999800002773=05121015432112345678");
  component.TransactionAmount = "25.00";
  component.EncryptedPIN = "623F36B53CC18393";
  component.KSN = "000000008F000021";
  component.CashBack = "5.00";
  component.Sale();

InvoiceNumber Property (GlobalDebit Component)

Optional invoice tracking number.

Syntax

C#
VB.NET

public string InvoiceNumber { get; set; }

Public Property InvoiceNumber As String

Default Value

Remarks

The maximum length for American Express cards is 16 characters, and 25 characters for all other card types. This property is required for the lowest rate on keyed transactions.

KSN Property (GlobalDebit Component)

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

Syntax

C#
VB.NET

public string KSN { get; set; }

Public Property KSN As String

Default Value

Remarks

A 16-byte Key Serial/Sequence Number (KSN) and associated EncryptedPIN are required for all debit Sale and Credit transactions. These values must be retrieved from a certified DUKPT DES pin pad device. The exact length of the Key Serial Number is 16 digits. If the PIN pad returns a 20 digit Key Serial Number and the first four characters are "FFFF", the component will internally strip the "FFFF" prior to passing the Key Serial Number to the Global Transport Gateway.

  Copy
  component.UserId = "4dpayments_retail";
  component.Password = "Passw0rd";  
  component.Card = new GlobalCard("9999999800002773=05121015432112345678");
  component.TransactionAmount = "25.00";
  component.EncryptedPIN = "623F36B53CC18393";
  component.KSN = "000000008F000021";
  component.CashBack = "5.00";
  component.Sale();

Password Property (GlobalDebit Component)

Password for authentication with the Global Payments Server

Syntax

C#
VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

Remarks

The Password will be supplied to you by Global Payments.

Proxy Property (GlobalDebit Component)

A set of properties related to proxy access.

Syntax

C#
VB.NET

public Proxy Proxy { get; set; }

Public Property Proxy As Proxy

Remarks

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

Please refer to the Proxy type for a complete list of fields.

RegisterNumber Property (GlobalDebit Component)

A number that uniquely identifies the register or computer on which the transaction was performed.

Syntax

C#
VB.NET

public string RegisterNumber { get; set; }

Public Property RegisterNumber As String

Default Value

Remarks

This may be up to 10 alphanumeric characters in length.

Response Property (GlobalDebit Component)

Contains the response to an EBT transaction.

Syntax

C#
VB.NET

public GlobalDebitResponse Response { get; }

Public ReadOnly Property Response As GlobalDebitResponse

Remarks

This property will contain the response returned from the Global Payments server. It should be inspected (and logged) after every transaction. The GlobalDebitResponse type contains the following fields:


ApprovalCode	Contains the transaction Authorization code from the card issuer.
BatchNumber	The number of the current batch, in which this transaction is contained.
CardType	Indicates the credit card type or payment method.
Code	Contains the transaction result code from the Global Transport Gateway.
Data	Contains the raw response from the Global Payments host.
HostCode	Action code (or sequence number) returned by Global Payments.
MerchantCode	Merchant Id code which must be printed on all receipts.
Message	Contains a human-readable response message concerning the processed transaction.
MessageDetail	Contains an additional, more detailed message about the results of the transaction.
PNRef	Uniquely identifies the transaction in the Global Transport Gateway.

This property is read-only.

Please refer to the GlobalDebitResponse type for a complete list of fields.

Server Property (GlobalDebit Component)

Global Payments transaction server.

Syntax

C#
VB.NET

public string Server { get; set; }

Public Property Server As String

Default Value

"https://api.globalpay.com"

Remarks

This is the server to which all transactions are sent. The live URL for Global Payments is "https://api.globalpay.com". For testing and certification purposes you may set this to the test server located at "https://certapia.globalpay.com" instead.

SSLAcceptServerCert Property (GlobalDebit Component)

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

Syntax

C#
VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

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

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

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

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (GlobalDebit Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

C#
VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

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

Please refer to the Certificate type for a complete list of fields.

SSLProvider Property (GlobalDebit Component)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

C#
VB.NET

public GlobalDebitSSLProviders SSLProvider { get; set; }

enum GlobalDebitSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Public Property SSLProvider As GlobaldebitSSLProviders

Enum GlobalDebitSSLProviders
  sslpAutomatic
  sslpPlatform
  sslpInternal
End Enum

Default Value

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 as follows:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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

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

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

SSLServerCert Property (GlobalDebit Component)

The server certificate for the last established connection.

Syntax

C#
VB.NET

public Certificate SSLServerCert { get; }

Public ReadOnly Property SSLServerCert As Certificate

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

Timeout Property (GlobalDebit Component)

The timeout for the component.

Syntax

C#
VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TransactionAmount Property (GlobalDebit Component)

Amount to be charged from (or refunded to) the card.

Syntax

C#
VB.NET

public string TransactionAmount { get; set; }

Public Property TransactionAmount As String

Default Value

Remarks

This is required for Sale and Refund transactions. The transaction amount may be up to 11 characters in length, and must be in the format "DDDDDDDD.CC", and be left-justified with no fill (eg: "1.99"). This must always be a positive, non-zero value.

UserId Property (GlobalDebit Component)

UserId for authentication with the Global Payments Server .

Syntax

C#
VB.NET

public string UserId { get; set; }

Public Property UserId As String

Default Value

Remarks

The UserId will be supplied to you by Global Payments.

Config Method (GlobalDebit Component)

Sets or retrieves a configuration setting.

Syntax

C#
VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

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

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

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

Interrupt Method (GlobalDebit Component)

This method interrupts the current method.

Syntax

C#
VB.NET

public void Interrupt();

Public Sub Interrupt()

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Refund Method (GlobalDebit Component)

Refunds a previous transaction.

Syntax

C#
VB.NET

public void Refund(string PNRef);

Public Sub Refund(ByVal PNRef As String)

Remarks

This method issues a refund based on a previously authorized Sale transaction.

To process a refund, set MagneticStripe, EncryptedPIN, and KSN then call Refund with the PNRef parameter set to the PNRef returned in response from the transaction for which you wish to issue a refund. If you leave the TransactionAmount blank, the full amount of the original transaction will be refunded. However, you may issue a partial refund for any value up to the original sale amount. For example:

Full Refund:

  Copy
component.Card = new GlobalCard("9999999800002773=05121015432112345678");
component.EncryptedPIN = "623F36B53CC18393";
component.KSN = "000000008F000021";  
component.Refund("123456"); // "123456" is the PNRef from the original transaction

Partial Refund:

  Copy
component.Card = new GlobalCard("9999999800002773=05121015432112345678");
component.EncryptedPIN = "623F36B53CC18393";
component.KSN = "000000008F000021";   
component.TransactionAmount = "15.00"; // Original transaction was for $25.00, so this is a partial refund
component.Refund("123456"); // "123456" is the PNRef from the original transaction

Note: Partial refunds are supported regardless of the time and date or batch status (open or closed). To perform a partial refund, pass any TransactionAmount that is less than the original transaction amount to the Refund transaction as per the example above.

Reset Method (GlobalDebit Component)

Clears all properties to their default values.

Syntax

C#
VB.NET

public void Reset();

Public Sub Reset()

Remarks

This method clears all properties to their default values.

Sale Method (GlobalDebit Component)

Sends a Sale transaction to the host.

Syntax

C#
VB.NET

public void Sale();

Public Sub Sale()

Remarks

A basic Sale transaction. This transaction immediately transfers the funds from the cardholders account. This transaction is automatically added to the current open batch, and will be settled after the current batch is settled. The batch settlement may be set up to occur automatically, or you can control when the batch settles with the GlobalBatchMgr component.

To perform a sale, set the MagneticStripe field with Track 2 data read off the card. PIN-based Debit card transactions cannot be manually entered, and are always card-present transactions. Sending Track 1 data in the MagneticStripe property will result in a failed transaction. You must also set the KSN and EncryptedPIN properties with data retrieved from the PIN pad after the customer enters their PIN. For example:

Sale transaction with Track 2 data:

  Copy
component.Card = new GlobalCard("4003000123456781=15125025432198712345");
component.EncryptedPIN = "7F8A30DB967DAB4D";
component.KSN = "3D01000042000007";
component.CashBack = "5.00";
component.TransactionAmount = "10.00"; //Total including CashBack
component.Sale();

Error Event (GlobalDebit Component)

Fired when information is available about errors during data delivery.

Syntax

C#
VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

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

Remarks

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

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

SSLServerAuthentication Event (GlobalDebit Component)

Fired after the server presents its certificate to the client.

Syntax

C#
VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

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

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

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

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

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

Remarks

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

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

SSLStatus Event (GlobalDebit Component)

Fired when secure connection progress messages are available.

Syntax

C#
VB.NET

public event OnSSLStatusHandler OnSSLStatus;

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

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

Public Event OnSSLStatus As OnSSLStatusHandler

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

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

Remarks

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

Status Event (GlobalDebit Component)

Shows the progress of the Global Payments connection.

Syntax

C#
VB.NET

public event OnStatusHandler OnStatus;

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

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

Public Event OnStatus As OnStatusHandler

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

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

Remarks

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

CCCard Type

Contains the customer's credit card information.

Remarks

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

Example: Setting the Fields

  Copy
CCCard card = new CCCard();
card.MagneticStripe = "B4012000033330026^FDMS TEST CARD   /VISA^090410054321000000000000000  150  A";
card.EntryDataSource = edsTrack1;

Example: Using a Constructor

  Copy
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

  Copy
CCCard card = new CCCard();
card.Number = "4788250000028291";
card.ExpMonth = 12;
card.ExpYear = 2010;
card.EntryDataSource = edsManualEntryNoCardReader;

Example: Using a Constructor

  Copy
CCCard card = new CCCard("4012000033330026", 04, 2009);

Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any other value for the EntryDataSource, you must set it yourself before authorizing the transaction.

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

The following fields are available:

CardType
CVVData
CVVPresence
EntryDataSource
ExpMonth
ExpYear
IsEncrypted
MagneticStripe
Number

Fields

CardType
TCardTypes
Default: 0

Type of credit card being used in this transaction. This field 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: ""

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

This alphanumeric field 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 field 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 field 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
CCCVVPresences
Default: 0

Indicates the presence of the card verification value.

This field 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
EntryDataSources
Default: 0

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


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
int
Default: 1

Expiration month of the credit card specified in Number.

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

ExpYear
int
Default: 2000

Expiration year of the credit card specified in Number.

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

IsEncrypted
bool
Default: 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: ""

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

If EntryDataSource is not one of the manually entered enumerations, then this field 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 field with track 1 or track 2 data, and may not pass both. Use the EntryDataSource field to indicate which track you are sending.

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

  Copy
component.Card = new CCCard("B4788250000028291^TSYS^05121015432112345678", dsTrack1)

or 

component.Card = new CCCard("4788250000028291=05121015432112345678", dsTrack2)

or

CCCardType Card = new CCCard()
Card.MagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
Card.EntryDataSource = dsTrack1

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

Customer's credit card number for the transaction.

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

Constructors

C#
VB.NET

public CCCard();

Public CCCard()

C#
VB.NET

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

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

C#
VB.NET

public CCCard(string magneticStripe, EntryDataSources entryDataSource);

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

Certificate Type

This is the digital certificate being used.

Remarks

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

The following fields are available:

Fields

EffectiveDate
string (read-only)
Default: ""

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

ExpirationDate
string (read-only)
Default: ""

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
string (read-only)
Default: ""

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

Fingerprint
string (read-only)
Default: ""

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

FingerprintSHA1
string (read-only)
Default: ""

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

FingerprintSHA256
string (read-only)
Default: ""

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

Issuer
string (read-only)
Default: ""

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

PrivateKey
string (read-only)
Default: ""

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
bool (read-only)
Default: False

Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

PrivateKeyContainer
string (read-only)
Default: ""

The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

PublicKey
string (read-only)
Default: ""

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
string (read-only)
Default: ""

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default: 0

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

SerialNumber
string (read-only)
Default: ""

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

SignatureAlgorithm
string (read-only)
Default: ""

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
string
Default: "MY"

The name of the certificate store for the client certificate.

The StoreType field 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 field 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 field 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

StoreB
byte []
Default: "MY"

The name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

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.

StorePassword
string
Default: ""

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

StoreType
CertStoreTypes
Default: 0

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 field 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: C# Copy `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
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.

SubjectAltNames
string (read-only)
Default: ""

Comma-separated lists of alternative subject names for the certificate.

ThumbprintMD5
string (read-only)
Default: ""

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA1
string (read-only)
Default: ""

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

ThumbprintSHA256
string (read-only)
Default: ""

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
string (read-only)
Default: ""

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

Digital Signature
Non-Repudiation
Key Encipherment
Data Encipherment
Key Agreement
Certificate Signing
CRL Signing
Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int (read-only)
Default: 0

The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signature
0x40	Non-Repudiation
0x20	Key Encipherment
0x10	Data Encipherment
0x08	Key Agreement
0x04	Certificate Signing
0x02	CRL Signing
0x01	Encipher Only

Please see the Usage field for a text representation of UsageFlags.

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

Version
string (read-only)
Default: ""

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Subject
string
Default: ""

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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=example@email.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.

Encoded
string
Default: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields 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.

EncodedB
byte []
Default: ""

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

Constructors

C#
VB.NET

public Certificate();

Public Certificate()

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

C#
VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

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

C#
VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

Parses Encoded as an X.509 public key.

C#
VB.NET

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

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

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

C#
VB.NET

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

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

ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

C#
VB.NET

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

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

After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

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

StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

C#
VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

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

C#
VB.NET

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

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

After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.

GlobalDebitResponse Type

Contains the response to a debit transaction.

Remarks

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

The following fields are available:

ApprovalCode
BatchNumber
CardType
Code
Data
HostCode
InvoiceNumber
MerchantCode
Message
MessageDetail
PNRef

Fields

ApprovalCode
string (read-only)
Default: ""

Contains the transaction authorization code from the card issuer.

For approved transaction responses (Code 0 or 200) the Global Transport Gateway sends a 6-character approval code in the ApprovalCode field and a human-readable approval message in the Message field. In the case of a decline, the ApprovalCode will contain an error message. Your application should display the ApprovalCode as part of the approval message for an approved transaction. For declined responses, the HostCode field will contain an additional code that provides detail on the reason for the decline.

BatchNumber
string (read-only)
Default: ""

The number of the batch this transaction is currently contained in. If this is a reply to an AuthOnly transaction, the BatchNumber field will be blank, as auth-onlys are not added to the open batch until a Capture is performed.

CardType
string (read-only)
Default: ""

Indicates the card type or payment method.

For credit card transactions, this field will contain the name of the credit card type. For instance, "VISA", "MASTERCARD", "AMEX", etc. For Debit or Electronic Benefit transactions, this field will contain "DEBIT" or "EBT".

Code
string (read-only)
Default: ""

Contains the transaction result code from the Global Transport Gateway. This value signifies the result of the transaction (i.e. approved, declined, etc). When programmatically validating a transaction's result, this value should ALWAYS be used instead of any response message describing the result. See the table below for a full list of result codes and descriptions.


-100	Transaction NOT Processed; Generic Host Error.
0	Approved.
2	Invalid Transaction.
3	Invalid Transaction Type.
3	Unsupported Transaction Type.
4	Invalid Amount.
4	Invalid Cash Back Amount.
5	Invalid Merchant Information.
6	Time Out Waiting for Host Response.
7	Field Format Error. See Message and MessageDetail for more info.
7	Swiped and Card Present transactions are not supported in Card Not Present markets.
8	Not a Transaction Server.
11	Client Timeout Waiting for Response.
12	Declined.
14	Transaction Type Not Supported In This Version.
19	Original Transaction Id, PNRef, or Approval Code Not Found.
20	Customer Reference Number Not Found.
22	Invalid ABA Number.
23	Invalid Account Number.
24	Invalid Expiration Date.
25	Transaction Type Not Supported by Host.
26	Invalid Reference Number or PNRef.
27	Invalid Receipt Information.
28	Invalid Check Holder Name.
29	Invalid Check Number.
30	Check DL Verification Requires DL State.
31	Cannot perform multiple captures on a PreAuth.
40	Not Currently Supported.
50	Insufficient Funds Available.
99	General Error.
100	Invalid Transaction Returned from Host.
101	Timeout Value too Small or Invalid Time Out Value.
102	Processor Not Available.
103	Error Reading Response from Host.
104	Timeout waiting for Processor Response.
105	Credit Error.
106	Host Not Available.
107	Duplicate Suppression Timeout.
108	Void Error/Cannot void a previously voided or settled transaction.
109	Timeout Waiting for Host Response.
110	Duplicate Transaction.
111	Capture Error.
112	Failed AVS Check.
113	Cannot Exceed Sales Cap / Requested Refund Exceeds Available Refund Amount.
114	Cannot refund a voided transaction.
115	Sum of Tax, Tip, and Cash Back amount cannot exceed total Amount.
116	Unsupported Card Type.
117	Only Sales, Repeat Sales, Force Captures, and Post Authorizations can be refunded.
118	The amount of a Pre-Auth Complete (Capture) must be less than or equal to the original amount authorized. Please retry.
200	A Partial Authorization of a pre-paid card. This is considered an Approved transaction. Check the AuthorizedAmount field for the amount approved. See below for more information.
1000	Generic Host Error or General Exception. (Missing or invalid data). See Message and MessageDetail for more info.
1001	Invalid Login Information.
1002	Insufficient Privilege or Invalid Amount.
1002	AVS Only transactions are not supported in E-Commerce markets.
1002	Debit/EBT Return transactions must provide the PNRef from the original Sale. Please retry.
1002	Zip is required for AVS Only transaction type.
1003	Invalid Login Blocked.
1004	Invalid Login Deactivated.
1005	Transaction Type or Service Not Allowed.
1006	Unsupported Processor.
1007	Invalid Request Message.
1008	Invalid Version / The MAC value is required.
1010	Payment Type Not Supported.
1011	Error Starting Transaction.
1012	Error Finishing Transaction.
1013	Error Checking Duplicate.
1014	No Records To Settle (in the current batch).
1015	No Records To Process (in the current batch).

A Partial Authorization transaction occurs when the issuer authorizes part of the sale amount on a pre-paid credit card. The transaction is approved for an amount less than the original TransactionAmount, and the customer must tender the remaining balance with another form of payment. When a transaction is partially approved, the Code will contain "200", the Message will contain "Partial Approval", and the MessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the AuthorizedAmount will contain the amount of the transaction that was authorized, and the BalanceDue field will indicate the amount still owed by the customer.

If a partial authorization occurs and the customer does not wish to go through with the transaction, you must submit a reversal of the authorization in order to return funds to the prepaid card.

Data
string (read-only)
Default: ""

Contains the raw response data from the Global Payments host.

HostCode
string (read-only)
Default: ""

Action code returned by Global Payments.

Typically, if the transaction is approved, this will be the batch reference number. If the transaction is declined, the HostCode will indicate the reason for the decline. The table below lists the possible HostCode and Message combinations for error conditions.


HostCode	Message	Description
000	AP	Approved or Completed Successfully.
000	AP NEW INFO	Approved with updated cardholder data.
000	PARTIAL AP	Only part of the requested amount was approved.
001	CALL AE	Refer to American Express.
001	CALL DC	Refer to Diners Club.
001	CALL DISCOVER	Refer to Discover.
001	CALL ND	Call your Visa/MasterCard Voice Authorization Center.
001	CALL TK	Refer to TeleCheck.
001	CALL XXXXXXXXXX	Call indicated number.
001	ISSUER UNAVAIL	Global Payments cannot contact issuing bank for authorization.
002	CALL AE	Touchtone capture, won't roll to an operator.
002	CALL DC	Touchtone capture, won't roll to an operator.
002	CALL DISCOVER	Touchtone capture, won't roll to an operator.
002	CALL ND	Touchtone capture, won't roll to an operator.
002	CALL XXXXXXXXXX	Touchtone capture, won't roll to an operator.
002	ISSUER UNAVAIL	Touchtone capture, won't roll to an operator.
003	INVLD MERCH ID	Invalid Merchant ID.
004	PIC UP	Authorization Declined.
005	DECLINE	Authorization Declined.
005	DECLINE NEW INFO	Update cardholder data.
005	DECLINE TRY LATER	Try again in 3 days.
005	REVK PAY ORDERED	Stop payment of a specific recurring payment.
005	STOP PAY ORDERED	Stop all future recurring payments.
006	REVERSED	Requested transaction reversal was successful.
007	DECLINE-CV2 FAIL	Response for CVV2 failure. Declined. (Visa).
008	AP WITH ID	Approved with positive ID. Host does not capture this transaction.
012	INVLD TRAN CODE	Processing code entered is incorrect. Please refer to valid processing code.
013	INVLD AMOUNT	Amount entered is invalid.
014	INVLD ACCT	Account number does not pass issuer's edit checks.
014	INVLD CODE ACCT	Valid account number matched with a transaction code for a different card type.
014	INVLD CID	American Express CID failure.
019	PLEASE RETRY	Retry the transaction.
054	INVLD EXP DATE	Expiration date entered is incorrect.
055	PIN INVALID	Incorrect PIN entered.
058	UNAUTH TRANS	Merchant not set up for transaction code used.
075	MAX PIN RETRIES	Maximum PIN number entry attempts exceeded.
094	AP DUPE	Transaction entered is a duplicate.
0C1	SYSTEM UNAVAILABLE	Global Payments Check System unavailable.
0N2	INV AMT MATCH	The amount entered for a void or adjustment transaction does not match the amount stored in the host for that item.
0N3	INV ITEM NUM	The item number entered for a void or adjustment transaction is incorrect.
0N4	ITEM VOIDED	An adjustment or item review was attempted on a transaction previously voided.
0N5	MUST BALANCE NOW	Terminal has not been balanced within time specified in the Global Payments Merchant Master File for this merchant.
0N6	USE DUP THEN BAL	Originating device has not been balanced within time specified in the Global Payments Merchant Master File for this merchant, but merchant is set up to perform extra transactions before balancing.
0N7	NO DUP FOUND	Override transaction is attempted on a non-duplicated transaction.
0N8	INVALID DATA	Format of the transaction is incorrect.
0NA	NO TRANS FOUND	Reversal transaction is attempted on a transaction that is not in the open batch on the host.
0NC	AP NOT CAPTURED	Approved but not captured (applies only to credit card transactions)- stand in.
0NE	AP AUTH-ONLY	Approved but this EDC merchant is not set up to capture this card type (applies only to credit card transactions).
	PART AP AUTH-ONLY	Only part of the requested amount was approved, but this EDC merchant is not set up to capture this card type (applies only to credit card transactions).
0P1	APPROVED	Approved debit card transaction.
0P2	DB UNAVAIL 02	Global Payments is experiencing a problem.
0P5	UNAUTH USER	Merchant is not set up for debit on Global Payments Merchant Master File.
0P6	INVALID CARD	Invalid card number.
0T1	EDC UNAVAILABLE	EDC application down, try later.
0T2	DB UNAVAIL 01	Debit application down, try later.
121	EXCEEDS MAX AMT	Exceeds withdrawal amount limit.
121	EXCEEDS MAX AMT	Exceeds withdrawal amount limit.

IMPORTANT: When programmatically validating a transaction's result, the Code value should ALWAYS be used instead of any other response messages describing the result. For example, do not use HostCode, Message, MessageDetail, or any other responses, as these values may vary. This tables is included for informational purposes only.

InvoiceNumber
string (read-only)
Default: ""

Contains the same invoice number for the transaction that was originally sent in the request to the Global Transport Gateway. This field has a maximum length of 25 alphanumeric characters.

MerchantCode
string (read-only)
Default: ""

Merchant Id code which must be printed on all receipts.

This field will contain a 15-character code that identifies the merchant on the Global Payments host.

Message
string (read-only)
Default: ""

Contains a human-readable response message concerning the processed transaction.

This value is typically either Approved or Declined, but may also contain a description of any error condition. Do NOT use this when programmatically validating a transaction's result; use the Code field instead.

MessageDetail
string (read-only)
Default: ""

Contains a formatted response message concerning the processed transaction. This field will contain an additional message about the results of the transaction, providing more detail than the Message field alone. For approved transactions this field will typically be "APPROVAL", and for declined transactions will contain a detailed error message. Do NOT use this when programmatically validating a transaction's result; Use the Code field instead.

Note: For Debit Card Sales and Refund, the string value in MessageDetail includes non-printable characters. Global Transport removes all non-printable characters from the returned MessageDetail.

PNRef
string (read-only)
Default: ""

Contains a number which uniquely identifies the transaction in the Global Transport system.

This value should be stored by the POS to enable the processing transactions based on a previous transaction. For instance, Capture, Void, Refund, TipAdjustment, etc.

Constructors

C#
VB.NET

public GlobalDebitResponse();

Public GlobalDebitResponse()

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.

The following fields are available:

AuthScheme
AutoDetect
Password
Port
Server
SSL
User

Fields

AuthScheme
ProxyAuthSchemes
Default: 0

The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields 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 fields 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 field will clear the values of User and Password.

AutoDetect
bool
Default: False

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Password
string
Default: ""

A password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields 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 fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int
Default: 80

The Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.

Server
string
Default: ""

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

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

SSL
ProxySSLTypes
Default: 0

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

A username if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password fields 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 fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

C#
VB.NET

public Proxy();

Public Proxy()

C#
VB.NET

public Proxy(string server, int port);

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

C#
VB.NET

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

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

Config Settings (GlobalDebit 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.

GlobalDebit Config Settings

ContactOnly: Indicates if the POS device is only able to accept chip inserted EMV transactions.

Required if the point of sale is EMV capable. Valid values are:


True	Device is only capable of accepting chip inserted EMV transactions.
False	Device is capable of accepting contactless EMV transactions. (default)

EMVCapable: Indicates whether the Point of Sale is EMV enabled.

This configuration setting is required for transactions using EMV cards. Submit a value of True for an EMV transaction. Default value is False.

Note: This must be set to True even for swiped or keyed fallback transactions using EMV cards.

EMVData: The EMV data returned from a Pin Pad after reading an EMV card.

This configuration setting takes the entire TLV (tag-length-value) EMV data received from a Pin Pad after reading an EMV card.

EMVEntryDataSource: The EMV Data Entry Source (DES).

This configuration setting indicates how the values for the payment information were obtained.

Valid values are:


Value	Device Capability	Comments
0	EMV	Valid for EMV chip card transactions.
1	EMV Contactless	Valid for EMV contactless transactions.
4	EMV Swipe	Valid when the original EMV chip card or EMV contactless transactions could not be completed, requiring a fallback to magnetic card swipe.

Note: For swipe entry fallback transactions (EMV Swipe) the EMVCapable configuration setting must be set to True and PINCapable and ContactOnly configuration settings must match the capabilities of your point of sale.

PINCapable: Indicates if the POS device is capable of accepting PINs.

Required if the point of sale is EMV capable. Valid values are:


True	Device is capable of accepting PINs.
False	Device is not capable of accepting PINs. (default)

RawRequest: Returns the request sent to the server for debugging purposes.

After an operation this setting may be queried to return the request as it was sent to the server. This is useful for debugging purposes.

RawResponse: Returns the response received from the server for debugging purposes.

After an operation this setting may be queried to return the response as it was received from the server. This is useful for debugging purposes.

ResponseEMVData: The response EMV data.

This configuration setting contains the EMV Data in TLV (tag-length-value) format. This field will only be populated if an EMV transaction was performed and EMV Data was received in the response.

TCPClient Config Settings

CloseStreamAfterTransfer: If true, the component will close the upload or download stream after the transfer.

This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True.

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

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

FirewallAutoDetect: Tells the component whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by components that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

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 setting is provided for use by components that do not directly expose Firewall properties.

FirewallListener: If true, the component binds to a SOCKS firewall as a server (TCPClient only).

This entry is for TCPClient only and does not work for other components that descend from TCPClient.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the component throws an exception.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

Possible values are as follows:


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.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the component throws an exception.

Note: This setting is provided for use by components that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

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 acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration 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 macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (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.

Linger: When set to True, connections are terminated gracefully.

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

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.

LingerTime: Time in seconds to have the connection linger.

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

LocalHost: The name of the local host through which connections are initiated or accepted.

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 multihomed 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 multihomed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the component binds.

This configuration setting 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 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 configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

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.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration 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.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.example.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

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.

TcpNoDelay: Whether or not to delay when sending packets.

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

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component 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 as follows:


0	IPv4 only
1	IPv6 only
2	IPv6 with IPv4 fallback

UseNTLMv2: Whether to use NTLM V2.

When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

SSL Config Settings

CACertFilePaths: The paths to CA certificate files when using Mono on Unix/Linux.

This configuration setting specifies the paths on disk to certificate authority (CA) certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

The value is formatted as a list of paths separated by semicolons. The component will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

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 configuration setting has no effect if SSLProvider is set to Platform.

ReuseSSLSession: Determines if the SSL session is reused.

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.

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This configuration setting specifies whether the component will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the component throws an exception.

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 it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This configuration setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The component will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the component throws an exception.

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 it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength is 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.

Note: This configuration 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 configuration 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 configuration setting.

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

This configuration setting is only applicable to server components (e.g., TCPServer) see SSLServerCACerts for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

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 include the following:

  Copy
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 the following:

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

Example values when SSLProvider is set to Internalinclude the following:

  Copy
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_ECDH_RSA_WITH_AES_128_CBC_SHA");

Possible values when SSLProvider is set to Internal include the following:

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

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default - Client and Server)
TLS1.1	768 (Hex 300) (Default - Client)
TLS1	192 (Hex C0) (Default - Client)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

SSLEnabledProtocols: Transport Layer Security (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 that 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 supported only 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 available only 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, these 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.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is false by default, but it can be set to true to enable the extension.

This configuration setting is applicable only when SSLProvider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

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.

Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

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 traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.

Note: This configuration setting is applicable only when SSLProvider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.