GlobalBatchMgr Component
Properties Methods Events Config Settings Errors
The GlobalBatchMgr component is used to manage your Global Transport account. It can be used to check the connection to the , verify your merchant setup, retrieve a summary of transactions in the current batch, and capture (settle) the current batch.
Syntax
DPayments.DPaymentsSDK.Globalbatchmgr
Remarks
This component offers four different services:
CaptureAll |
Once a transaction request is approved with the GlobalCharge, GlobalDebit, or GlobalBenefit component, the transaction is added to the current batch on the Global Transport Server. For Debit and EBT cards the money is instantly transferred, but for Credit cards the money in the customer's account is blocked and tagged for the merchant, but not actually transferred yet. The credit card transaction must go through Settlement in order for the blocked money to be transferred to the merchant's account. If your Global Transport account is setup with the Host Auto Settle feature, you need take no further action. The Global Transport system will close the current open batch at a designated time each day. This means that there is no end of day batch processing required from the merchant. If your account is not set up to automatically settle transactions at the end of the day, then at the end of the day you will need to use the CaptureAll method to capture the transactions in the batch. |
CheckConnection | This method checks the status of the connection to the Global Payments server and validates the UserId and Password login credentials. |
CheckSetup | This method will return detailed information relating to the merchant's current setup as name/value pairs in the SetupFields collection. |
GetBatchSummary | This method retrieves information about all of the transactions in the current open batch, and stores this information in the SummaryResults collection. |
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
BatchResponse | Contains information about the current batch. |
BenefitTransactions | Contains the transaction totals for Electronic Benefit (EBT) Cards. |
CheckTransactions | Contains the transaction totals for electronic checks. |
CreditTransactions | Contains the transaction totals for Credit Cards. |
DebitTransactions | Contains the transaction totals for Debit Cards. |
ForceClose | Forces a batch Capture even if there are mismatched transaction totals. |
InquiryType | Indicates whether to perform an inquiry on the current batch or on the previous batch. |
Password | Password for authentication with the Global Payments Server |
Proxy | A set of properties related to proxy access. |
Server | Global Payments transaction server. |
SetupFields | Contains list of fields returned by Global Payments, which reflect the current state of the merchant setup. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
SummaryBeginDate | Optional filter for use when retrieving a batch summary. |
SummaryEndDate | Optional filter for use when retrieving a batch summary. |
SummaryResults | Contains summary results for all payment types in the current batch. |
Timeout | A timeout for the component. |
UserId | UserId for authentication with the Global Payments Server . |
VendorNumber | The merchant's RP/Vendor number |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
BatchInquiry | Retrieves the current state of the open batch. |
CaptureAll | Marks the current batch for settlement. |
CheckConnection | Checks the connection status to the Global Payments server and validates login information. |
CheckSetup | Retrieves information about the merchant's current setup. |
Config | Sets or retrieves a configuration setting. |
GetBatchSummary | Retrieves a summary of the current open batch for a merchant. |
Interrupt | Interrupt the current method. |
Reset | Clears all properties to their default values. |
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.
RawRequest | Returns the request sent to the server for debugging purposes. |
RawResponse | Returns the response received from the server for debugging purposes. |
SetupResultMode | Indicates whether to return simple or detailed information with the CheckSetup method. |
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 certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
BatchResponse Property (GlobalBatchMgr Component)
Contains information about the current batch.
Syntax
public GlobalBatchResponse BatchResponse { get; }
Public ReadOnly Property BatchResponse As GlobalBatchResponse
Remarks
This property is filled in response to a BatchInquiry, CaptureAll, or CheckConnection method call.
ApprovalCode | Contains the transaction Authorization code. |
BatchNumber | Indicates the number of the current batch. |
Code | Contains the transaction result code from the Global Transport Gateway. |
Message | Contains a human-readable response message concerning the processed transaction. |
MessageDetail | Contains a formatted response message concerning the processed transaction. |
NetTransAmount | The net dollar amount of all transactions. |
NetTransCount | This field contains the total number of transactions contained in the batch settlement. |
SettleDate | The date the batch was settled. |
This property is read-only.
Please refer to the GlobalBatchResponse type for a complete list of fields.BenefitTransactions Property (GlobalBatchMgr Component)
Contains the transaction totals for Electronic Benefit (EBT) Cards.
Syntax
public GlobalBatchTotals BenefitTransactions { get; }
Public ReadOnly Property BenefitTransactions As GlobalBatchTotals
Remarks
This property contains the total sale amount, total refund amount, and net total amount for all EBT card transactions contained in the batch. If no EBT transactions were made with the GlobalBenefit component (and none were made with the merchant's virtual terminal) these BenefitTransaction fields will be empty.
This property is populated when calling BatchInquiry and CaptureAll.
This property is read-only.
Please refer to the GlobalBatchTotals type for a complete list of fields.CheckTransactions Property (GlobalBatchMgr Component)
Contains the transaction totals for electronic checks.
Syntax
public GlobalBatchTotals CheckTransactions { get; }
Public ReadOnly Property CheckTransactions As GlobalBatchTotals
Remarks
This property contains a the total sale amount, total refund amount, and net total amount for all electronic check transactions contained in the batch. If no e-Check transactions were made using the merchant's virtual terminal, these CheckTransaction fields will be empty.
This property is populated when calling BatchInquiry and CaptureAll.
This property is read-only.
Please refer to the GlobalBatchTotals type for a complete list of fields.CreditTransactions Property (GlobalBatchMgr Component)
Contains the transaction totals for Credit Cards.
Syntax
public GlobalBatchTotals CreditTransactions { get; }
Public ReadOnly Property CreditTransactions As GlobalBatchTotals
Remarks
This property contains a the total sale amount, total refund amount, and net total amount for all credit card transactions contained in the batch. If no Credit transactions were made with the GlobalCharge component (and none were made with the merchant's virtual terminal) these CreditTransaction fields will be empty.
This property is populated when calling BatchInquiry and CaptureAll.
This property is read-only.
Please refer to the GlobalBatchTotals type for a complete list of fields.DebitTransactions Property (GlobalBatchMgr Component)
Contains the transaction totals for Debit Cards.
Syntax
public GlobalBatchTotals DebitTransactions { get; }
Public ReadOnly Property DebitTransactions As GlobalBatchTotals
Remarks
This property contains a the total sale amount, total refund amount, and net total amount for all debit card transactions contained in the batch. If no Debit transactions were made with the GlobalDebit component (and none were made with the merchant's virtual terminal) these DebitTransaction fields will be empty.
This property is populated when calling BatchInquiry and CaptureAll.
This property is read-only.
Please refer to the GlobalBatchTotals type for a complete list of fields.ForceClose Property (GlobalBatchMgr Component)
Forces a batch Capture even if there are mismatched transaction totals.
Syntax
Default Value
False
Remarks
Calling CaptureAll with ForceClose set to True will settle all transactions for all payment types in the current batch regardless of whether the totals match with the Global Payments server (which can happen if there are timeouts or discrepancies based on other connectivity issues). This function should only be used when the merchant's account is setup for "merchant-initiated" close on the Global Payments server and if a normal CaptureAll batch close request fails with a "MUST BALANCE NOW" response.
InquiryType Property (GlobalBatchMgr Component)
Indicates whether to perform an inquiry on the current batch or on the previous batch.
Syntax
public GlobalbatchmgrInquiryTypes InquiryType { get; set; }
enum GlobalbatchmgrInquiryTypes { itCurrentBatch, itPreviousBatch }
Public Property InquiryType As GlobalbatchmgrInquiryTypes
Enum GlobalbatchmgrInquiryTypes itCurrentBatch itPreviousBatch End Enum
Default Value
0
Remarks
This property is used by the BatchInquiry method to indicate whether you wish to retrieve results for the current open batch, or for the most recently closed batch. This property is not applicable for the GetBatchSummary method.
Password Property (GlobalBatchMgr Component)
Password for authentication with the Global Payments Server
Syntax
Default Value
""
Remarks
The Password will be supplied to you by Global Payments.
Proxy Property (GlobalBatchMgr Component)
A set of properties related to proxy access.
Syntax
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.Server Property (GlobalBatchMgr Component)
Global Payments transaction server.
Syntax
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.
SetupFields Property (GlobalBatchMgr Component)
Contains list of fields returned by Global Payments, which reflect the current state of the merchant setup.
Syntax
public GlobalSetupFieldList SetupFields { get; }
Public ReadOnly Property SetupFields As GlobalSetupFieldList
Remarks
The fields returned by the Global Pay server will be dependent on the current merchant setup as well as whether you requested basic or advanced setup information. For instance, you may receive FieldName of "PaymentTypes", where the Value contains a list of the currently supported card types. "LiveUrl", "TestUrl", "Partner", "Vendor" and a other settings may also be contained in this collection.
This property is read-only.
Please refer to the GlobalSetupField type for a complete list of fields.SSLAcceptServerCert Property (GlobalBatchMgr Component)
Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate SSLAcceptServerCert { get; set; }
Public Property SSLAcceptServerCert As Certificate
Remarks
If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (GlobalBatchMgr Component)
The certificate to be used during SSL negotiation.
Syntax
public Certificate SSLCert { get; set; }
Public Property SSLCert As Certificate
Remarks
The digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLProvider Property (GlobalBatchMgr Component)
This specifies the SSL/TLS implementation to use.
Syntax
public GlobalbatchmgrSSLProviders SSLProvider { get; set; }
enum GlobalbatchmgrSSLProviders { sslpAutomatic, sslpPlatform, sslpInternal }
Public Property SSLProvider As GlobalbatchmgrSSLProviders
Enum GlobalbatchmgrSSLProviders sslpAutomatic sslpPlatform sslpInternal End Enum
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, on Windows the component will use the platform implementation. On Linux/macOS the component will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
The .NET Standard library will always use the internal implementation on all platforms.
SSLServerCert Property (GlobalBatchMgr Component)
The server certificate for the last established connection.
Syntax
public Certificate SSLServerCert { get; }
Public ReadOnly Property SSLServerCert As Certificate
Remarks
SSLServerCert contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.SummaryBeginDate Property (GlobalBatchMgr Component)
Optional filter for use when retrieving a batch summary.
Syntax
Default Value
""
Remarks
The begin date of the date range may be entered in "MM/DD/YYYY" format if you wish. This date will be converted by the Global system to: "MM/DD/YYYYT00:00:00:0000AM."
SummaryEndDate Property (GlobalBatchMgr Component)
Optional filter for use when retrieving a batch summary.
Syntax
Default Value
""
Remarks
The end date of the date range may be entered in "MM/DD/YYYY" format if you wish. This date will be converted by the Global system to "MM/DD/YYYYT12:59:59:9999PM".
SummaryResults Property (GlobalBatchMgr Component)
Contains summary results for all payment types in the current batch.
Syntax
public GlobalSummaryResultList SummaryResults { get; }
Public ReadOnly Property SummaryResults As GlobalSummaryResultList
Remarks
This property contains the results after a successful call to the GetBatchSummary method. Each GlobalSummaryResult in the collection will contain a summary for the payment type specified by the PaymentType field. This includes the total dollar amounts and transaction counts of all the Sale, Refund, Force, Auth-only, and Recurring transactions, as well as the total number of transactions made for that particular PaymentType.
This property is read-only.
Please refer to the GlobalSummaryResult type for a complete list of fields.Timeout Property (GlobalBatchMgr Component)
A timeout for the component.
Syntax
Default Value
60
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.
Please note that by default, all timeouts are inactivity timeouts, i.e. 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.
UserId Property (GlobalBatchMgr Component)
UserId for authentication with the Global Payments Server .
Syntax
Default Value
""
Remarks
The UserId will be supplied to you by Global Payments.
VendorNumber Property (GlobalBatchMgr Component)
The merchant's RP/Vendor number
Syntax
Default Value
""
Remarks
The Vendor number is also known as the "RP Number" or "RPNum", and is required by the GetBatchSummary method to retrieve information about transactions in the current open batch. If you do not know your Vendor/RPNum you may log into your Global Payments virtual terminal, or simply use the CheckSetup method to find it.
BatchInquiry Method (GlobalBatchMgr Component)
Retrieves the current state of the open batch.
Syntax
public void BatchInquiry();
Public Sub BatchInquiry()
Remarks
A batch inquiry will provide the host batch totals to the Point Of Sale (POS). If the POS and the Host are out of balance, discrepancies can be corrected (using the virtual terminal or GlobalTransactionSearch component) prior to the batch being captured. A batch inquiry will not release the batch for settlement. Use the CaptureAll method or Global Payments' online merchant interface to settle the batch.
The results of a batch inquiry will be returned in the BatchResponse property, and transaction totals will be contained in the CreditTransactions, DebitTransactions, BenefitTransactions, and CheckTransactions properties. To inquire about the most recent closed batch (instead of the current open batch), set the InquiryType property to itPreviousBatch.
CaptureAll Method (GlobalBatchMgr Component)
Marks the current batch for settlement.
Syntax
public void CaptureAll();
Public Sub CaptureAll()
Remarks
This operation will settle all transactions for all payment types in the current batch. This function should only be used when the merchant's account is setup for "merchant-initiated" close on the Global Payments server. The results of the CaptureAll will be returned in the BatchResponse property, and any transaction totals that may be returned will be contained in the CreditTransactions, DebitTransactions, BenefitTransactions, and CheckTransactions properties.
CheckConnection Method (GlobalBatchMgr Component)
Checks the connection status to the Global Payments server and validates login information.
Syntax
public void CheckConnection();
Public Sub CheckConnection()
Remarks
Returns "OK" in the ApprovalCode field if a connection can be made to the Global Transport Gateway with the supplied UserId and Password otherwise the Code and Message will indicate an error condition.
CheckSetup Method (GlobalBatchMgr Component)
Retrieves information about the merchant's current setup.
Syntax
public void CheckSetup();
Public Sub CheckSetup()
Remarks
This method will return information relating to the merchant's current setup as name/value pairs. By default, the component returns detailed information about the merchant. if you wish for a simpler response, the SetupResultMode configuration setting can be used to switch between basic and advanced (default) result modes. In either case, results of the CheckSetup method call will be contained within the SetupFields property.
Config Method (GlobalBatchMgr Component)
Sets or retrieves a configuration setting.
Syntax
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.
GetBatchSummary Method (GlobalBatchMgr Component)
Retrieves a summary of the current open batch for a merchant.
Syntax
public void GetBatchSummary();
Public Sub GetBatchSummary()
Remarks
* This method is no longer available as the underlying Global Transport API has changed. This method retrieves information about all of the transactions in the current open batch, and stores this information in the SummaryResults collection. The results will be separated by payment type ("MasterCard", "Visa", "DEBIT", etc.). You may optionally set a start and ending date to filter transactions with, using the SummaryBeginDate and SummaryEndDate properties.
To retrieve a summary of all transactions (even transactions that have already been settled) use the GlobalTransactionSearch component's GetTransactionSummary method instead.
Interrupt Method (GlobalBatchMgr Component)
Interrupt the current method.
Syntax
public void Interrupt();
Public Sub Interrupt()
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
Reset Method (GlobalBatchMgr Component)
Clears all properties to their default values.
Syntax
public void Reset();
Public Sub Reset()
Remarks
This method clears all properties to their default values.
Error Event (GlobalBatchMgr Component)
Fired when information is available about errors during data delivery.
Syntax
public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, GlobalbatchmgrErrorEventArgs e); public class GlobalbatchmgrErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } }
Public Event OnError As OnErrorHandler Public Delegate Sub OnErrorHandler(sender As Object, e As GlobalbatchmgrErrorEventArgs) Public Class GlobalbatchmgrErrorEventArgs 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 (GlobalBatchMgr Component)
Fired after the server presents its certificate to the client.
Syntax
public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication; public delegate void OnSSLServerAuthenticationHandler(object sender, GlobalbatchmgrSSLServerAuthenticationEventArgs e); public class GlobalbatchmgrSSLServerAuthenticationEventArgs : 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 GlobalbatchmgrSSLServerAuthenticationEventArgs) Public Class GlobalbatchmgrSSLServerAuthenticationEventArgs 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 (GlobalBatchMgr Component)
Fired when secure connection progress messages are available.
Syntax
public event OnSSLStatusHandler OnSSLStatus; public delegate void OnSSLStatusHandler(object sender, GlobalbatchmgrSSLStatusEventArgs e); public class GlobalbatchmgrSSLStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnSSLStatus As OnSSLStatusHandler Public Delegate Sub OnSSLStatusHandler(sender As Object, e As GlobalbatchmgrSSLStatusEventArgs) Public Class GlobalbatchmgrSSLStatusEventArgs 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 (GlobalBatchMgr Component)
Shows the progress of the Global Payments connection.
Syntax
public event OnStatusHandler OnStatus; public delegate void OnStatusHandler(object sender, GlobalbatchmgrStatusEventArgs e); public class GlobalbatchmgrStatusEventArgs : EventArgs { public string Message { get; } }
Public Event OnStatus As OnStatusHandler Public Delegate Sub OnStatusHandler(sender As Object, e As GlobalbatchmgrStatusEventArgs) Public Class GlobalbatchmgrStatusEventArgs 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.
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
Fields
EffectiveDate
string (read-only)
Default Value: ""
This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
Encoded
string
Default Value: ""
This is 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 Value: ""
This is 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.
ExpirationDate
string (read-only)
Default Value: ""
This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
string
Default Value: ""
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
string (read-only)
Default Value: ""
This is 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 Value: ""
This is 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 Value: ""
This is 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 Value: ""
This is 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 Value: ""
This is 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 Value: False
This field shows 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 Value: ""
This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
string (read-only)
Default Value: ""
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
string
Default Value: ""
This field contains 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 Value: 0
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
string (read-only)
Default Value: ""
This is 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 Value: ""
The field contains 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 Value: "MY"
This is 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte []
Default Value: "MY"
This is 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
string
Default Value: ""
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
StoreType
CertStoreTypes
Default Value: 0
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This 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:
|
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. |
Subject
string
Default Value: ""
This is 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=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
SubjectAltNames
string (read-only)
Default Value: ""
This field contains comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
string (read-only)
Default Value: ""
This field contains 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 Value: ""
This field contains 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 Value: ""
This field contains 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
Default Value: ""
This field contains the text description of UsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signatures
- Key Authentication
- Key Encryption
- Data Encryption
- Key Agreement
- Certificate Signing
- Key Signing
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int
Default Value: 0
This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signatures |
0x40 | Key Authentication (Non-Repudiation) |
0x20 | Key Encryption |
0x10 | Data Encryption |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | Key Signing |
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 Value: ""
This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Constructors
public Certificate();
Public Certificate()
Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.
public Certificate(string certificateFile);
Public Certificate(ByVal CertificateFile As String)
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate(byte[] certificateData);
Public Certificate(ByVal CertificateData As Byte())
Parses CertificateData as an X.509 public key.
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or Base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN).
public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);
Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())
CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or Base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
GlobalBatchResponse Type
The response from a batch management transaction.
Remarks
This type will contain a response to a batch settlement, batch inquiry, or connection check.
Fields
ApprovalCode
string (read-only)
Default Value: ""
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.
After a call to CheckConnection this field will contain "OK" if everything is okay. If not, the Code, Message, and MessageDetail will indicate the problem. For batch settlement responses it will contain the approval code. For all other transaction responses ApprovalCode will remain empty.
BatchNumber
string (read-only)
Default Value: ""
Indicates the number of the current batch.
If this is a response to a BatchInquiry transaction, this field will contain the number of the current open batch. If in response to a CaptureAll transaction this field will contain the number of the batch that was just closed.
Code
string (read-only)
Default Value: ""
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.
Message
string (read-only)
Default Value: ""
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 Value: ""
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.
NetTransAmount
string (read-only)
Default Value: ""
The net dollar amount of all transactions.
This is the total transaction amount of the settlement, minus all refunds. If positive it indicates a payment to the merchant. If negative it means more refunds than sales were contained in the batch, and the merchant will be charged. Note that a void transaction DOES count towards the total NetTransAmount, but a Refund or Credit subtracts from it.
For instance, a batch containing one $10 transaction and one $10 void will have a NetTransAmount of "20.00". However, a batch containing one $10 transaction and one $3 refund will have a NetTransAmount of "7.00". In either case, the NetTransCount will be 2.
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".
NetTransCount
int (read-only)
Default Value: 0
This field contains the total number of transactions contained in the batch settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).
SettleDate
string (read-only)
Default Value: ""
The date the batch was settled. This date field is in the format "YYYY-MM-DD HH:MM:SS"
Constructors
public GlobalBatchResponse();
Public GlobalBatchResponse()
GlobalBatchTotals Type
Contains the transaction totals for a particular transaction type.
Remarks
This type contains the net transaction amount, total refund amount, and total sale amount that are contained in the batch for a particular transaction type.
Fields
NetAmount
string (read-only)
Default Value: ""
The net dollar amount of all transactions of a particular transaction type.
This is the total amount of all the transactions (for this transaction type) in the settlement - including sales, voids, captures, and forces - minus all refunds/credits. If positive it indicates net payment to the merchant. If negative it means more refunds than sales were contained in the batch, and a net loss for the merchant. Note that a Void transaction DOES count towards the total NetAmount, but a Refund or Credit transaction subtracts from it.
For instance, a batch containing one $10 Charge and one $10 Void of this type will have a NetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a NetAmount of "7.00". In either case, the NetCount will be 2.
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".
NetCount
int (read-only)
Default Value: 0
This field contains the total number of transactions (for this transaction type) in the settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).
RefundAmount
string (read-only)
Default Value: ""
This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.
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".
RefundCount
int (read-only)
Default Value: 0
This field contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.
SaleAmount
string (read-only)
Default Value: ""
This is the total amount of all Sale transactions (for this transaction type) in the settlement.
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".
SaleCount
int (read-only)
Default Value: 0
This field contains the total number of Sale transactions (for this transaction type) in the settlement.
Constructors
public GlobalBatchTotals();
Public GlobalBatchTotals()
GlobalSetupField Type
Contains a field returned by Global Payments which reflects the current state of the merchant setup.
Remarks
The fields returned by the Global Pay server will be dependent on the current merchant setup as well as whether you requested basic or advanced setup information. For instance, you may receive FieldName of "PaymentTypes", and the Value will contain a list of the currently supported card types. "LiveUrl", "TestUrl", "Partner", "Vendor" and other settings may also be returned.
Fields
FieldName
string (read-only)
Default Value: ""
Contains the name of a field returned by Global Payments, which reflects the current state of the merchant setup.
Value
string (read-only)
Default Value: ""
Contains the value of a field returned by Global Payments, which reflects the current state of the merchant setup.
Constructors
public GlobalSetupField();
Public GlobalSetupField()
public GlobalSetupField(string fieldName, string value);
Public GlobalSetupField(ByVal FieldName As String, ByVal Value As String)
GlobalSummaryResult Type
Contains a summary for a single payment type.
Remarks
This type will contain a summary for the payment type specified by the PaymentType field. This includes the total dollar amounts and transaction counts of all the Sale, Refund, Force, Auth-only, and Recurring transactions, as well as the total number of transactions made for that particular PaymentType.
Fields
AuthorizationAmount
string (read-only)
Default Value: ""
Contains the dollar amount authorized for all transactions for the indicated PaymentType.
AuthorizationCount
int (read-only)
Default Value: 0
* No longer supported as the underlying Global API has changed.
Contains the transaction count of all Authorization-only transactions for the indicated PaymentType. Auth-only transactions are also known as preauth transactions.
CaptureAmount
string (read-only)
Default Value: ""
Contains the dollar amount captured for all transactions for the indicated PaymentType.
CaptureCount
int (read-only)
Default Value: 0
Contains the transaction count of all transactions that have been settled for the indicated PaymentType.
ForceCaptureAmount
string (read-only)
Default Value: ""
* No longer supported as the underlying Global API has changed.
Contains the dollar amount of all Force transactions for the indicated PaymentType.
ForceCaptureCount
int (read-only)
Default Value: 0
* No longer supported as the underlying Global API has changed.
Contains the transaction count of all Force transactions for the indicated PaymentType.
PaymentType
string (read-only)
Default Value: ""
The type of transactions being summarized.
This field varies based on the value specified via SearchCriteriaCardBreakdown. When set to 'False', PaymentType will be set to transaction type returned in the response such as "Sale", "Return", "Force", etc.
When set to 'True', PaymentType will be set to the card and transaction type returned in the response and separated by " - " such as "VISA - Force", "MasterCard - Return", "Discover - Sale", etc.
PostAuthAmount
string (read-only)
Default Value: ""
* No longer supported as the underlying Global API has changed.
Contains the dollar amount of all PreAuth Complete (Capture) transactions for the indicated PaymentType.
PostAuthCount
int (read-only)
Default Value: 0
* No longer supported as the underlying Global API has changed.
Contains the transaction count of all PreAuth Complete (Capture) transactions for the indicated PaymentType.
RefundAmount
string (read-only)
Default Value: ""
* No longer supported as the underlying Global API has changed.
Contains the dollar amount of all Refund and Credit transactions for the indicated PaymentType.
RefundCount
int (read-only)
Default Value: 0
* No longer supported as the underlying Global API has changed.
Contains the transaction count of all Refund and Credit transactions for the indicated PaymentType.
RepeatSaleAmount
string (read-only)
Default Value: ""
* No longer supported as the underlying Global API has changed.
Contains the dollar amount of all RepeatSale (Recurring Billing) transactions for the indicated PaymentType.
RepeatSaleCount
int (read-only)
Default Value: 0
* No longer supported as the underlying Global API has changed.
Contains the transaction count of all RepeatSale (Recurring Billing) transactions for the indicated PaymentType.
SaleAmount
string (read-only)
Default Value: ""
* No longer supported as the underlying Global API has changed.
Contains the dollar amount of all Sale transactions for the indicated PaymentType.
SaleCount
int (read-only)
Default Value: 0
* No longer supported as the underlying Global API has changed.
Contains the transaction count of all Sale transactions for the indicated PaymentType.
TotalCount
int (read-only)
Default Value: 0
Contains the total count of all transactions for the indicated PaymentType.
Constructors
public GlobalSummaryResult();
Public GlobalSummaryResult()
Proxy Type
The proxy the component will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
ProxyAuthSchemes
Default Value: 0
This field is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the User and Password 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 Value: False
This field tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Password
string
Default Value: ""
This field contains a password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password 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 Value: 80
This field contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.
Server
string
Default Value: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server 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 Value: 0
This field determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
psAlways (1) | The connection is always SSL enabled. |
psNever (2) | The connection is not SSL enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
User
string
Default Value: ""
This field contains 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
Config Settings (GlobalBatchMgr 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.GlobalBatchMgr Config Settings
TCPClient Config Settings
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
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.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.
LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.
This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.
If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.
The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this config is set to false.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
If set to true, the component will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default) the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
When set to 0 (default) the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
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.
When set, the component will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the component will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available in Java or when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the component throws an exception.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for UDP ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.
Note: This setting is static. The value set is applicable to all components used in the application.
When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.
Trappable Errors (GlobalBatchMgr Component)
GlobalBatchMgr Errors
432 Invalid index. | |
501 Invalid length for this property. | |
502 Invalid data format for this property. | |
503 Value is out of range. | |
504 Credit card digit check failed. | |
505 Card date invalid. | |
506 Card expired. | |
519 Corrupt response. | |
520 Response payload empty. | |
526 Invalid timeout value. | |
593 A property required for this transaction is missing. | |
529 Error in XML response. | |
533 Internal error constructing payload. |
The component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 Already connected. If you want to reconnect, close the current connection first. | |
106 You cannot change the LocalPort at this time. A connection is in progress. | |
107 You cannot change the LocalHost at this time. A connection is in progress. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
117 You cannot change the UseConnection option while the component is active. | |
135 Operation would block. | |
201 Timeout. | |
211 Action impossible in control's present state. | |
212 Action impossible while not connected. | |
213 Action impossible while listening. | |
301 Timeout. | |
303 Could not open file. | |
434 Unable to convert string to selected CodePage. | |
1105 Already connecting. If you want to reconnect, close the current connection first. | |
1117 You need to connect first. | |
1119 You cannot change the LocalHost at this time. A connection is in progress. | |
1120 Connection dropped by remote host. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |