GlobalBatchMgr Class

Properties   Methods   Events   Config Settings   Errors  

The GlobalBatchMgr class is used to manage your Global Transport account. It can be used to check the connection to the Server , verify your merchant setup, retrieve a summary of transactions in the current batch, and capture (settle) the current batch.

Syntax

GlobalBatchMgr

Remarks

This class offers four different services:

CaptureAll

Once a transaction request is approved with the GlobalCharge, GlobalDebit, or GlobalBenefit class, 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.

CheckConnectionThis method checks the status of the connection to the Global Payments server and validates the UserId and Password login credentials.
CheckSetupThis method will return detailed information relating to the merchant's current setup as name/value pairs in the SetupFields collection.
GetBatchSummaryThis 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 class with short descriptions. Click on the links for further details.

BatchResponseApprovalCodeContains the transaction authorization code from the card issuer.
BatchResponseBatchNumberIndicates the number of the current batch.
BatchResponseCodeContains the transaction result code from the Global Transport Gateway.
BatchResponseMessageContains a human-readable response message concerning the processed transaction.
BatchResponseMessageDetailContains a formatted response message concerning the processed transaction.
BatchResponseNetTransAmountThe net dollar amount of all transactions.
BatchResponseNetTransCountThis property contains the total number of transactions contained in the batch settlement.
BatchResponseSettleDateThe date the batch was settled.
BenefitTransNetAmountThe net dollar amount of all transactions of a particular transaction type.
BenefitTransNetCountThis property contains the total number of transactions (for this transaction type) in the settlement.
BenefitTransRefundAmountThis is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.
BenefitTransRefundCountThis property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.
BenefitTransSaleAmountThis is the total amount of all Sale transactions (for this transaction type) in the settlement.
BenefitTransSaleCountThis property contains the total number of Sale transactions (for this transaction type) in the settlement.
CheckTransNetAmountThe net dollar amount of all transactions of a particular transaction type.
CheckTransNetCountThis property contains the total number of transactions (for this transaction type) in the settlement.
CheckTransRefundAmountThis is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.
CheckTransRefundCountThis property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.
CheckTransSaleAmountThis is the total amount of all Sale transactions (for this transaction type) in the settlement.
CheckTransSaleCountThis property contains the total number of Sale transactions (for this transaction type) in the settlement.
CreditTransNetAmountThe net dollar amount of all transactions of a particular transaction type.
CreditTransNetCountThis property contains the total number of transactions (for this transaction type) in the settlement.
CreditTransRefundAmountThis is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.
CreditTransRefundCountThis property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.
CreditTransSaleAmountThis is the total amount of all Sale transactions (for this transaction type) in the settlement.
CreditTransSaleCountThis property contains the total number of Sale transactions (for this transaction type) in the settlement.
DebitTransNetAmountThe net dollar amount of all transactions of a particular transaction type.
DebitTransNetCountThis property contains the total number of transactions (for this transaction type) in the settlement.
DebitTransRefundAmountThis is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.
DebitTransRefundCountThis property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.
DebitTransSaleAmountThis is the total amount of all Sale transactions (for this transaction type) in the settlement.
DebitTransSaleCountThis property contains the total number of Sale transactions (for this transaction type) in the settlement.
ForceCloseForces a batch Capture even if there are mismatched transaction totals.
InquiryTypeIndicates whether to perform an inquiry on the current batch or on the previous batch.
PasswordPassword for authentication with the Global Payments Server .
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a username if authentication is to be used for the proxy.
ServerGlobal Payments transaction server.
SetupFieldCountThe number of records in the SetupField arrays.
SetupFieldNameContains the name of a property returned by Global Payments, which reflects the current state of the merchant setup.
SetupFieldValueContains the value of a property returned by Global Payments, which reflects the current state of the merchant setup.
SSLAcceptServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SummaryBeginDateOptional filter for use when retrieving a batch summary.
SummaryEndDateOptional filter for use when retrieving a batch summary.
SummaryResultCountThe number of records in the SummaryResult arrays.
SummaryResultAuthorizationAmountContains the dollar amount authorized for all transactions for the indicated PaymentType .
SummaryResultAuthorizationCount* No longer supported as the underlying Global API has changed.
SummaryResultCaptureAmountContains the dollar amount captured for all transactions for the indicated PaymentType .
SummaryResultCaptureCountContains the transaction count of all transactions that have been settled for the indicated PaymentType .
SummaryResultForceCaptureAmount* No longer supported as the underlying Global API has changed.
SummaryResultForceCaptureCount* No longer supported as the underlying Global API has changed.
SummaryResultPaymentTypeThe type of transactions being summarized.
SummaryResultPostAuthAmount* No longer supported as the underlying Global API has changed.
SummaryResultPostAuthCount* No longer supported as the underlying Global API has changed.
SummaryResultRefundAmount* No longer supported as the underlying Global API has changed.
SummaryResultRefundCount* No longer supported as the underlying Global API has changed.
SummaryResultRepeatSaleAmount* No longer supported as the underlying Global API has changed.
SummaryResultRepeatSaleCount* No longer supported as the underlying Global API has changed.
SummaryResultSaleAmount* No longer supported as the underlying Global API has changed.
SummaryResultSaleCount* No longer supported as the underlying Global API has changed.
SummaryResultTotalCountContains the total count of all transactions for the indicated PaymentType .
TimeoutA timeout for the class.
UserIdUserId for authentication with the Global Payments Server .
VendorNumberThe merchant's RP/Vendor number.

Method List


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

BatchInquiryRetrieves the current state of the open batch.
CaptureAllMarks the current batch for settlement.
CheckConnectionChecks the connection status to the Global Payments server and validates login information.
CheckSetupRetrieves information about the merchant's current setup.
ConfigSets or retrieves a configuration setting.
GetBatchSummaryRetrieves a summary of the current open batch for a merchant.
InterruptInterrupt the current method.
ResetClears all properties to their default values.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorFired when information is available about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StatusShows the progress of the Global Payments connection.

Config Settings


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

RawRequestReturns the request sent to the server for debugging purposes.
RawResponseReturns the response received from the server for debugging purposes.
SetupResultModeIndicates whether to return simple or detailed information with the CheckSetup method.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

BatchResponseApprovalCode Property (GlobalBatchMgr Class)

Contains the transaction authorization code from the card issuer.

Syntax

ANSI (Cross Platform)
char* GetBatchResponseApprovalCode();

Unicode (Windows)
LPWSTR GetBatchResponseApprovalCode();
char* dpaymentssdk_globalbatchmgr_getbatchresponseapprovalcode(void* lpObj);
QString GetBatchResponseApprovalCode();

Default Value

""

Remarks

Contains the transaction authorization code from the card issuer.

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

After a call to CheckConnection this property will contain "OK" if everything is okay. If not, the BatchResponseCode, BatchResponseMessage, and BatchResponseMessageDetail will indicate the problem. For batch settlement responses it will contain the approval code. For all other transaction responses BatchResponseApprovalCode will remain empty.

This property is read-only.

Data Type

String

BatchResponseBatchNumber Property (GlobalBatchMgr Class)

Indicates the number of the current batch.

Syntax

ANSI (Cross Platform)
char* GetBatchResponseBatchNumber();

Unicode (Windows)
LPWSTR GetBatchResponseBatchNumber();
char* dpaymentssdk_globalbatchmgr_getbatchresponsebatchnumber(void* lpObj);
QString GetBatchResponseBatchNumber();

Default Value

""

Remarks

Indicates the number of the current batch.

If this is a response to a BatchInquiry transaction, this property will contain the number of the current open batch. If in response to a CaptureAll transaction this property will contain the number of the batch that was just closed.

This property is read-only.

Data Type

String

BatchResponseCode Property (GlobalBatchMgr Class)

Contains the transaction result code from the Global Transport Gateway.

Syntax

ANSI (Cross Platform)
char* GetBatchResponseCode();

Unicode (Windows)
LPWSTR GetBatchResponseCode();
char* dpaymentssdk_globalbatchmgr_getbatchresponsecode(void* lpObj);
QString GetBatchResponseCode();

Default Value

""

Remarks

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.

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

This property is read-only.

Data Type

String

BatchResponseMessage Property (GlobalBatchMgr Class)

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

Syntax

ANSI (Cross Platform)
char* GetBatchResponseMessage();

Unicode (Windows)
LPWSTR GetBatchResponseMessage();
char* dpaymentssdk_globalbatchmgr_getbatchresponsemessage(void* lpObj);
QString GetBatchResponseMessage();

Default Value

""

Remarks

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 BatchResponseCode property instead.

This property is read-only.

Data Type

String

BatchResponseMessageDetail Property (GlobalBatchMgr Class)

Contains a formatted response message concerning the processed transaction.

Syntax

ANSI (Cross Platform)
char* GetBatchResponseMessageDetail();

Unicode (Windows)
LPWSTR GetBatchResponseMessageDetail();
char* dpaymentssdk_globalbatchmgr_getbatchresponsemessagedetail(void* lpObj);
QString GetBatchResponseMessageDetail();

Default Value

""

Remarks

Contains a formatted response message concerning the processed transaction. This property will contain an additional message about the results of the transaction, providing more detail than the BatchResponseMessage property alone. For approved transactions this property 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 BatchResponseCode property instead.

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

This property is read-only.

Data Type

String

BatchResponseNetTransAmount Property (GlobalBatchMgr Class)

The net dollar amount of all transactions.

Syntax

ANSI (Cross Platform)
char* GetBatchResponseNetTransAmount();

Unicode (Windows)
LPWSTR GetBatchResponseNetTransAmount();
char* dpaymentssdk_globalbatchmgr_getbatchresponsenettransamount(void* lpObj);
QString GetBatchResponseNetTransAmount();

Default Value

""

Remarks

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 BatchResponseNetTransAmount, but a Refund or Credit subtracts from it.

For instance, a batch containing one $10 transaction and one $10 void will have a BatchResponseNetTransAmount of "20.00". However, a batch containing one $10 transaction and one $3 refund will have a BatchResponseNetTransAmount of "7.00". In either case, the BatchResponseNetTransCount 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".

This property is read-only.

Data Type

String

BatchResponseNetTransCount Property (GlobalBatchMgr Class)

This property contains the total number of transactions contained in the batch settlement.

Syntax

ANSI (Cross Platform)
int GetBatchResponseNetTransCount();

Unicode (Windows)
INT GetBatchResponseNetTransCount();
int dpaymentssdk_globalbatchmgr_getbatchresponsenettranscount(void* lpObj);
int GetBatchResponseNetTransCount();

Default Value

0

Remarks

This property 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).

This property is read-only.

Data Type

Integer

BatchResponseSettleDate Property (GlobalBatchMgr Class)

The date the batch was settled.

Syntax

ANSI (Cross Platform)
char* GetBatchResponseSettleDate();

Unicode (Windows)
LPWSTR GetBatchResponseSettleDate();
char* dpaymentssdk_globalbatchmgr_getbatchresponsesettledate(void* lpObj);
QString GetBatchResponseSettleDate();

Default Value

""

Remarks

The date the batch was settled. This date property is in the format "YYYY-MM-DD HH:MM:SS"

This property is read-only.

Data Type

String

BenefitTransNetAmount Property (GlobalBatchMgr Class)

The net dollar amount of all transactions of a particular transaction type.

Syntax

ANSI (Cross Platform)
char* GetBenefitTransNetAmount();

Unicode (Windows)
LPWSTR GetBenefitTransNetAmount();
char* dpaymentssdk_globalbatchmgr_getbenefittransnetamount(void* lpObj);
QString GetBenefitTransNetAmount();

Default Value

""

Remarks

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 BenefitTransNetAmount, 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 BenefitTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a BenefitTransNetAmount of "7.00". In either case, the BenefitTransNetCount 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".

This property is read-only.

Data Type

String

BenefitTransNetCount Property (GlobalBatchMgr Class)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetBenefitTransNetCount();

Unicode (Windows)
INT GetBenefitTransNetCount();
int dpaymentssdk_globalbatchmgr_getbenefittransnetcount(void* lpObj);
int GetBenefitTransNetCount();

Default Value

0

Remarks

This property 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).

This property is read-only.

Data Type

Integer

BenefitTransRefundAmount Property (GlobalBatchMgr Class)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
char* GetBenefitTransRefundAmount();

Unicode (Windows)
LPWSTR GetBenefitTransRefundAmount();
char* dpaymentssdk_globalbatchmgr_getbenefittransrefundamount(void* lpObj);
QString GetBenefitTransRefundAmount();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

BenefitTransRefundCount Property (GlobalBatchMgr Class)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetBenefitTransRefundCount();

Unicode (Windows)
INT GetBenefitTransRefundCount();
int dpaymentssdk_globalbatchmgr_getbenefittransrefundcount(void* lpObj);
int GetBenefitTransRefundCount();

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

BenefitTransSaleAmount Property (GlobalBatchMgr Class)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
char* GetBenefitTransSaleAmount();

Unicode (Windows)
LPWSTR GetBenefitTransSaleAmount();
char* dpaymentssdk_globalbatchmgr_getbenefittranssaleamount(void* lpObj);
QString GetBenefitTransSaleAmount();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

BenefitTransSaleCount Property (GlobalBatchMgr Class)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetBenefitTransSaleCount();

Unicode (Windows)
INT GetBenefitTransSaleCount();
int dpaymentssdk_globalbatchmgr_getbenefittranssalecount(void* lpObj);
int GetBenefitTransSaleCount();

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CheckTransNetAmount Property (GlobalBatchMgr Class)

The net dollar amount of all transactions of a particular transaction type.

Syntax

ANSI (Cross Platform)
char* GetCheckTransNetAmount();

Unicode (Windows)
LPWSTR GetCheckTransNetAmount();
char* dpaymentssdk_globalbatchmgr_getchecktransnetamount(void* lpObj);
QString GetCheckTransNetAmount();

Default Value

""

Remarks

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 CheckTransNetAmount, 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 CheckTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a CheckTransNetAmount of "7.00". In either case, the CheckTransNetCount 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".

This property is read-only.

Data Type

String

CheckTransNetCount Property (GlobalBatchMgr Class)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetCheckTransNetCount();

Unicode (Windows)
INT GetCheckTransNetCount();
int dpaymentssdk_globalbatchmgr_getchecktransnetcount(void* lpObj);
int GetCheckTransNetCount();

Default Value

0

Remarks

This property 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).

This property is read-only.

Data Type

Integer

CheckTransRefundAmount Property (GlobalBatchMgr Class)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
char* GetCheckTransRefundAmount();

Unicode (Windows)
LPWSTR GetCheckTransRefundAmount();
char* dpaymentssdk_globalbatchmgr_getchecktransrefundamount(void* lpObj);
QString GetCheckTransRefundAmount();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

CheckTransRefundCount Property (GlobalBatchMgr Class)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetCheckTransRefundCount();

Unicode (Windows)
INT GetCheckTransRefundCount();
int dpaymentssdk_globalbatchmgr_getchecktransrefundcount(void* lpObj);
int GetCheckTransRefundCount();

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CheckTransSaleAmount Property (GlobalBatchMgr Class)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
char* GetCheckTransSaleAmount();

Unicode (Windows)
LPWSTR GetCheckTransSaleAmount();
char* dpaymentssdk_globalbatchmgr_getchecktranssaleamount(void* lpObj);
QString GetCheckTransSaleAmount();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

CheckTransSaleCount Property (GlobalBatchMgr Class)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetCheckTransSaleCount();

Unicode (Windows)
INT GetCheckTransSaleCount();
int dpaymentssdk_globalbatchmgr_getchecktranssalecount(void* lpObj);
int GetCheckTransSaleCount();

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CreditTransNetAmount Property (GlobalBatchMgr Class)

The net dollar amount of all transactions of a particular transaction type.

Syntax

ANSI (Cross Platform)
char* GetCreditTransNetAmount();

Unicode (Windows)
LPWSTR GetCreditTransNetAmount();
char* dpaymentssdk_globalbatchmgr_getcredittransnetamount(void* lpObj);
QString GetCreditTransNetAmount();

Default Value

""

Remarks

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 CreditTransNetAmount, 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 CreditTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a CreditTransNetAmount of "7.00". In either case, the CreditTransNetCount 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".

This property is read-only.

Data Type

String

CreditTransNetCount Property (GlobalBatchMgr Class)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetCreditTransNetCount();

Unicode (Windows)
INT GetCreditTransNetCount();
int dpaymentssdk_globalbatchmgr_getcredittransnetcount(void* lpObj);
int GetCreditTransNetCount();

Default Value

0

Remarks

This property 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).

This property is read-only.

Data Type

Integer

CreditTransRefundAmount Property (GlobalBatchMgr Class)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
char* GetCreditTransRefundAmount();

Unicode (Windows)
LPWSTR GetCreditTransRefundAmount();
char* dpaymentssdk_globalbatchmgr_getcredittransrefundamount(void* lpObj);
QString GetCreditTransRefundAmount();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

CreditTransRefundCount Property (GlobalBatchMgr Class)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetCreditTransRefundCount();

Unicode (Windows)
INT GetCreditTransRefundCount();
int dpaymentssdk_globalbatchmgr_getcredittransrefundcount(void* lpObj);
int GetCreditTransRefundCount();

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CreditTransSaleAmount Property (GlobalBatchMgr Class)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
char* GetCreditTransSaleAmount();

Unicode (Windows)
LPWSTR GetCreditTransSaleAmount();
char* dpaymentssdk_globalbatchmgr_getcredittranssaleamount(void* lpObj);
QString GetCreditTransSaleAmount();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

CreditTransSaleCount Property (GlobalBatchMgr Class)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetCreditTransSaleCount();

Unicode (Windows)
INT GetCreditTransSaleCount();
int dpaymentssdk_globalbatchmgr_getcredittranssalecount(void* lpObj);
int GetCreditTransSaleCount();

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

DebitTransNetAmount Property (GlobalBatchMgr Class)

The net dollar amount of all transactions of a particular transaction type.

Syntax

ANSI (Cross Platform)
char* GetDebitTransNetAmount();

Unicode (Windows)
LPWSTR GetDebitTransNetAmount();
char* dpaymentssdk_globalbatchmgr_getdebittransnetamount(void* lpObj);
QString GetDebitTransNetAmount();

Default Value

""

Remarks

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 DebitTransNetAmount, 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 DebitTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a DebitTransNetAmount of "7.00". In either case, the DebitTransNetCount 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".

This property is read-only.

Data Type

String

DebitTransNetCount Property (GlobalBatchMgr Class)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetDebitTransNetCount();

Unicode (Windows)
INT GetDebitTransNetCount();
int dpaymentssdk_globalbatchmgr_getdebittransnetcount(void* lpObj);
int GetDebitTransNetCount();

Default Value

0

Remarks

This property 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).

This property is read-only.

Data Type

Integer

DebitTransRefundAmount Property (GlobalBatchMgr Class)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
char* GetDebitTransRefundAmount();

Unicode (Windows)
LPWSTR GetDebitTransRefundAmount();
char* dpaymentssdk_globalbatchmgr_getdebittransrefundamount(void* lpObj);
QString GetDebitTransRefundAmount();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

DebitTransRefundCount Property (GlobalBatchMgr Class)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetDebitTransRefundCount();

Unicode (Windows)
INT GetDebitTransRefundCount();
int dpaymentssdk_globalbatchmgr_getdebittransrefundcount(void* lpObj);
int GetDebitTransRefundCount();

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

DebitTransSaleAmount Property (GlobalBatchMgr Class)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
char* GetDebitTransSaleAmount();

Unicode (Windows)
LPWSTR GetDebitTransSaleAmount();
char* dpaymentssdk_globalbatchmgr_getdebittranssaleamount(void* lpObj);
QString GetDebitTransSaleAmount();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

DebitTransSaleCount Property (GlobalBatchMgr Class)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

ANSI (Cross Platform)
int GetDebitTransSaleCount();

Unicode (Windows)
INT GetDebitTransSaleCount();
int dpaymentssdk_globalbatchmgr_getdebittranssalecount(void* lpObj);
int GetDebitTransSaleCount();

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

ForceClose Property (GlobalBatchMgr Class)

Forces a batch Capture even if there are mismatched transaction totals.

Syntax

ANSI (Cross Platform)
int GetForceClose();
int SetForceClose(int bForceClose); Unicode (Windows) BOOL GetForceClose();
INT SetForceClose(BOOL bForceClose);
int dpaymentssdk_globalbatchmgr_getforceclose(void* lpObj);
int dpaymentssdk_globalbatchmgr_setforceclose(void* lpObj, int bForceClose);
bool GetForceClose();
int SetForceClose(bool bForceClose);

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.

Data Type

Boolean

InquiryType Property (GlobalBatchMgr Class)

Indicates whether to perform an inquiry on the current batch or on the previous batch.

Syntax

ANSI (Cross Platform)
int GetInquiryType();
int SetInquiryType(int iInquiryType); Unicode (Windows) INT GetInquiryType();
INT SetInquiryType(INT iInquiryType);

Possible Values

IT_CURRENT_BATCH(0), 
IT_PREVIOUS_BATCH(1)
int dpaymentssdk_globalbatchmgr_getinquirytype(void* lpObj);
int dpaymentssdk_globalbatchmgr_setinquirytype(void* lpObj, int iInquiryType);
int GetInquiryType();
int SetInquiryType(int iInquiryType);

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.

Data Type

Integer

Password Property (GlobalBatchMgr Class)

Password for authentication with the Global Payments Server .

Syntax

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
char* dpaymentssdk_globalbatchmgr_getpassword(void* lpObj);
int dpaymentssdk_globalbatchmgr_setpassword(void* lpObj, const char* lpszPassword);
QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

ProxyAuthScheme Property (GlobalBatchMgr Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); Unicode (Windows) INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

Possible Values

AUTH_BASIC(0), 
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5)
int dpaymentssdk_globalbatchmgr_getproxyauthscheme(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (GlobalBatchMgr Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect); Unicode (Windows) BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);
int dpaymentssdk_globalbatchmgr_getproxyautodetect(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyautodetect(void* lpObj, int bProxyAutoDetect);
bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (GlobalBatchMgr Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* dpaymentssdk_globalbatchmgr_getproxypassword(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (GlobalBatchMgr Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int dpaymentssdk_globalbatchmgr_getproxyport(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (GlobalBatchMgr Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer); Unicode (Windows) LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);
char* dpaymentssdk_globalbatchmgr_getproxyserver(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyserver(void* lpObj, const char* lpszProxyServer);
QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (GlobalBatchMgr Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL); Unicode (Windows) INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

Possible Values

PS_AUTOMATIC(0), 
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
int dpaymentssdk_globalbatchmgr_getproxyssl(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyssl(void* lpObj, int iProxySSL);
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

psAutomatic (0)Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class 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.

Data Type

Integer

ProxyUser Property (GlobalBatchMgr Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser); Unicode (Windows) LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);
char* dpaymentssdk_globalbatchmgr_getproxyuser(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyuser(void* lpObj, const char* lpszProxyUser);
QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

Server Property (GlobalBatchMgr Class)

Global Payments transaction server.

Syntax

ANSI (Cross Platform)
char* GetServer();
int SetServer(const char* lpszServer); Unicode (Windows) LPWSTR GetServer();
INT SetServer(LPCWSTR lpszServer);
char* dpaymentssdk_globalbatchmgr_getserver(void* lpObj);
int dpaymentssdk_globalbatchmgr_setserver(void* lpObj, const char* lpszServer);
QString GetServer();
int SetServer(QString qsServer);

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.

Data Type

String

SetupFieldCount Property (GlobalBatchMgr Class)

The number of records in the SetupField arrays.

Syntax

ANSI (Cross Platform)
int GetSetupFieldCount();

Unicode (Windows)
INT GetSetupFieldCount();
int dpaymentssdk_globalbatchmgr_getsetupfieldcount(void* lpObj);
int GetSetupFieldCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SetupFieldCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SetupFieldName Property (GlobalBatchMgr Class)

Contains the name of a property returned by Global Payments, which reflects the current state of the merchant setup.

Syntax

ANSI (Cross Platform)
char* GetSetupFieldName(int iSetupFieldIndex);

Unicode (Windows)
LPWSTR GetSetupFieldName(INT iSetupFieldIndex);
char* dpaymentssdk_globalbatchmgr_getsetupfieldname(void* lpObj, int setupfieldindex);
QString GetSetupFieldName(int iSetupFieldIndex);

Default Value

""

Remarks

Contains the name of a field returned by Global Payments, which reflects the current state of the merchant setup.

The SetupFieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SetupFieldCount property.

This property is read-only and not available at design time.

Data Type

String

SetupFieldValue Property (GlobalBatchMgr Class)

Contains the value of a property returned by Global Payments, which reflects the current state of the merchant setup.

Syntax

ANSI (Cross Platform)
char* GetSetupFieldValue(int iSetupFieldIndex);

Unicode (Windows)
LPWSTR GetSetupFieldValue(INT iSetupFieldIndex);
char* dpaymentssdk_globalbatchmgr_getsetupfieldvalue(void* lpObj, int setupfieldindex);
QString GetSetupFieldValue(int iSetupFieldIndex);

Default Value

""

Remarks

Contains the value of a field returned by Global Payments, which reflects the current state of the merchant setup.

The SetupFieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SetupFieldCount property.

This property is read-only and not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (GlobalBatchMgr Class)

This is the certificate (PEM/Base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded); Unicode (Windows) INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);
int dpaymentssdk_globalbatchmgr_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_globalbatchmgr_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);
QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (GlobalBatchMgr Class)

This is the certificate (PEM/Base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int dpaymentssdk_globalbatchmgr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_globalbatchmgr_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (GlobalBatchMgr Class)

This is the name of the certificate store for the client certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int dpaymentssdk_globalbatchmgr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_globalbatchmgr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot 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).

Data Type

Binary String

SSLCertStorePassword Property (GlobalBatchMgr Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* dpaymentssdk_globalbatchmgr_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (GlobalBatchMgr Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int dpaymentssdk_globalbatchmgr_getsslcertstoretype(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. 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 SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (GlobalBatchMgr Class)

This is the subject of the certificate used for client authentication.

Syntax

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* dpaymentssdk_globalbatchmgr_getsslcertsubject(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (GlobalBatchMgr Class)

This specifies the SSL/TLS implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int dpaymentssdk_globalbatchmgr_getsslprovider(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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 class 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.
Additional Notes

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

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

Data Type

Integer

SSLServerCertEncoded Property (GlobalBatchMgr Class)

This is the certificate (PEM/Base64 encoded).

Syntax

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int dpaymentssdk_globalbatchmgr_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);
QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

SummaryBeginDate Property (GlobalBatchMgr Class)

Optional filter for use when retrieving a batch summary.

Syntax

ANSI (Cross Platform)
char* GetSummaryBeginDate();
int SetSummaryBeginDate(const char* lpszSummaryBeginDate); Unicode (Windows) LPWSTR GetSummaryBeginDate();
INT SetSummaryBeginDate(LPCWSTR lpszSummaryBeginDate);
char* dpaymentssdk_globalbatchmgr_getsummarybegindate(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsummarybegindate(void* lpObj, const char* lpszSummaryBeginDate);
QString GetSummaryBeginDate();
int SetSummaryBeginDate(QString qsSummaryBeginDate);

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

Data Type

String

SummaryEndDate Property (GlobalBatchMgr Class)

Optional filter for use when retrieving a batch summary.

Syntax

ANSI (Cross Platform)
char* GetSummaryEndDate();
int SetSummaryEndDate(const char* lpszSummaryEndDate); Unicode (Windows) LPWSTR GetSummaryEndDate();
INT SetSummaryEndDate(LPCWSTR lpszSummaryEndDate);
char* dpaymentssdk_globalbatchmgr_getsummaryenddate(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsummaryenddate(void* lpObj, const char* lpszSummaryEndDate);
QString GetSummaryEndDate();
int SetSummaryEndDate(QString qsSummaryEndDate);

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

Data Type

String

SummaryResultCount Property (GlobalBatchMgr Class)

The number of records in the SummaryResult arrays.

Syntax

ANSI (Cross Platform)
int GetSummaryResultCount();

Unicode (Windows)
INT GetSummaryResultCount();
int dpaymentssdk_globalbatchmgr_getsummaryresultcount(void* lpObj);
int GetSummaryResultCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SummaryResultCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultAuthorizationAmount Property (GlobalBatchMgr Class)

Contains the dollar amount authorized for all transactions for the indicated PaymentType .

Syntax

ANSI (Cross Platform)
char* GetSummaryResultAuthorizationAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultAuthorizationAmount(INT iSummaryIndex);
char* dpaymentssdk_globalbatchmgr_getsummaryresultauthorizationamount(void* lpObj, int summaryindex);
QString GetSummaryResultAuthorizationAmount(int iSummaryIndex);

Default Value

""

Remarks

Contains the dollar amount authorized for all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultAuthorizationCount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
int GetSummaryResultAuthorizationCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultAuthorizationCount(INT iSummaryIndex);
int dpaymentssdk_globalbatchmgr_getsummaryresultauthorizationcount(void* lpObj, int summaryindex);
int GetSummaryResultAuthorizationCount(int iSummaryIndex);

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Authorization-only transactions for the indicated SummaryResultPaymentType. Auth-only transactions are also known as preauth transactions.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultCaptureAmount Property (GlobalBatchMgr Class)

Contains the dollar amount captured for all transactions for the indicated PaymentType .

Syntax

ANSI (Cross Platform)
char* GetSummaryResultCaptureAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultCaptureAmount(INT iSummaryIndex);
char* dpaymentssdk_globalbatchmgr_getsummaryresultcaptureamount(void* lpObj, int summaryindex);
QString GetSummaryResultCaptureAmount(int iSummaryIndex);

Default Value

""

Remarks

Contains the dollar amount captured for all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultCaptureCount Property (GlobalBatchMgr Class)

Contains the transaction count of all transactions that have been settled for the indicated PaymentType .

Syntax

ANSI (Cross Platform)
int GetSummaryResultCaptureCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultCaptureCount(INT iSummaryIndex);
int dpaymentssdk_globalbatchmgr_getsummaryresultcapturecount(void* lpObj, int summaryindex);
int GetSummaryResultCaptureCount(int iSummaryIndex);

Default Value

0

Remarks

Contains the transaction count of all transactions that have been settled for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultForceCaptureAmount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
char* GetSummaryResultForceCaptureAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultForceCaptureAmount(INT iSummaryIndex);
char* dpaymentssdk_globalbatchmgr_getsummaryresultforcecaptureamount(void* lpObj, int summaryindex);
QString GetSummaryResultForceCaptureAmount(int iSummaryIndex);

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Force transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultForceCaptureCount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
int GetSummaryResultForceCaptureCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultForceCaptureCount(INT iSummaryIndex);
int dpaymentssdk_globalbatchmgr_getsummaryresultforcecapturecount(void* lpObj, int summaryindex);
int GetSummaryResultForceCaptureCount(int iSummaryIndex);

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Force transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultPaymentType Property (GlobalBatchMgr Class)

The type of transactions being summarized.

Syntax

ANSI (Cross Platform)
char* GetSummaryResultPaymentType(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultPaymentType(INT iSummaryIndex);
char* dpaymentssdk_globalbatchmgr_getsummaryresultpaymenttype(void* lpObj, int summaryindex);
QString GetSummaryResultPaymentType(int iSummaryIndex);

Default Value

""

Remarks

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.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultPostAuthAmount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
char* GetSummaryResultPostAuthAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultPostAuthAmount(INT iSummaryIndex);
char* dpaymentssdk_globalbatchmgr_getsummaryresultpostauthamount(void* lpObj, int summaryindex);
QString GetSummaryResultPostAuthAmount(int iSummaryIndex);

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all PreAuth Complete (Capture) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultPostAuthCount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
int GetSummaryResultPostAuthCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultPostAuthCount(INT iSummaryIndex);
int dpaymentssdk_globalbatchmgr_getsummaryresultpostauthcount(void* lpObj, int summaryindex);
int GetSummaryResultPostAuthCount(int iSummaryIndex);

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all PreAuth Complete (Capture) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultRefundAmount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
char* GetSummaryResultRefundAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultRefundAmount(INT iSummaryIndex);
char* dpaymentssdk_globalbatchmgr_getsummaryresultrefundamount(void* lpObj, int summaryindex);
QString GetSummaryResultRefundAmount(int iSummaryIndex);

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Refund and Credit transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultRefundCount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
int GetSummaryResultRefundCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultRefundCount(INT iSummaryIndex);
int dpaymentssdk_globalbatchmgr_getsummaryresultrefundcount(void* lpObj, int summaryindex);
int GetSummaryResultRefundCount(int iSummaryIndex);

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Refund and Credit transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultRepeatSaleAmount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
char* GetSummaryResultRepeatSaleAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultRepeatSaleAmount(INT iSummaryIndex);
char* dpaymentssdk_globalbatchmgr_getsummaryresultrepeatsaleamount(void* lpObj, int summaryindex);
QString GetSummaryResultRepeatSaleAmount(int iSummaryIndex);

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all RepeatSale (Recurring Billing) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultRepeatSaleCount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
int GetSummaryResultRepeatSaleCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultRepeatSaleCount(INT iSummaryIndex);
int dpaymentssdk_globalbatchmgr_getsummaryresultrepeatsalecount(void* lpObj, int summaryindex);
int GetSummaryResultRepeatSaleCount(int iSummaryIndex);

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all RepeatSale (Recurring Billing) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultSaleAmount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
char* GetSummaryResultSaleAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultSaleAmount(INT iSummaryIndex);
char* dpaymentssdk_globalbatchmgr_getsummaryresultsaleamount(void* lpObj, int summaryindex);
QString GetSummaryResultSaleAmount(int iSummaryIndex);

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Sale transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultSaleCount Property (GlobalBatchMgr Class)

* No longer supported as the underlying Global API has changed.

Syntax

ANSI (Cross Platform)
int GetSummaryResultSaleCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultSaleCount(INT iSummaryIndex);
int dpaymentssdk_globalbatchmgr_getsummaryresultsalecount(void* lpObj, int summaryindex);
int GetSummaryResultSaleCount(int iSummaryIndex);

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Sale transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultTotalCount Property (GlobalBatchMgr Class)

Contains the total count of all transactions for the indicated PaymentType .

Syntax

ANSI (Cross Platform)
int GetSummaryResultTotalCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultTotalCount(INT iSummaryIndex);
int dpaymentssdk_globalbatchmgr_getsummaryresulttotalcount(void* lpObj, int summaryindex);
int GetSummaryResultTotalCount(int iSummaryIndex);

Default Value

0

Remarks

Contains the total count of all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

Timeout Property (GlobalBatchMgr Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int dpaymentssdk_globalbatchmgr_gettimeout(void* lpObj);
int dpaymentssdk_globalbatchmgr_settimeout(void* lpObj, int iTimeout);
int GetTimeout();
int SetTimeout(int iTimeout);

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 class will wait for the operation to complete before returning control.

The class 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 class fails with an error.

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.

Data Type

Integer

UserId Property (GlobalBatchMgr Class)

UserId for authentication with the Global Payments Server .

Syntax

ANSI (Cross Platform)
char* GetUserId();
int SetUserId(const char* lpszUserId); Unicode (Windows) LPWSTR GetUserId();
INT SetUserId(LPCWSTR lpszUserId);
char* dpaymentssdk_globalbatchmgr_getuserid(void* lpObj);
int dpaymentssdk_globalbatchmgr_setuserid(void* lpObj, const char* lpszUserId);
QString GetUserId();
int SetUserId(QString qsUserId);

Default Value

""

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

VendorNumber Property (GlobalBatchMgr Class)

The merchant's RP/Vendor number.

Syntax

ANSI (Cross Platform)
char* GetVendorNumber();
int SetVendorNumber(const char* lpszVendorNumber); Unicode (Windows) LPWSTR GetVendorNumber();
INT SetVendorNumber(LPCWSTR lpszVendorNumber);
char* dpaymentssdk_globalbatchmgr_getvendornumber(void* lpObj);
int dpaymentssdk_globalbatchmgr_setvendornumber(void* lpObj, const char* lpszVendorNumber);
QString GetVendorNumber();
int SetVendorNumber(QString qsVendorNumber);

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.

Data Type

String

BatchInquiry Method (GlobalBatchMgr Class)

Retrieves the current state of the open batch.

Syntax

ANSI (Cross Platform)
int BatchInquiry();

Unicode (Windows)
INT BatchInquiry();
int dpaymentssdk_globalbatchmgr_batchinquiry(void* lpObj);
int 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 class) 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CaptureAll Method (GlobalBatchMgr Class)

Marks the current batch for settlement.

Syntax

ANSI (Cross Platform)
int CaptureAll();

Unicode (Windows)
INT CaptureAll();
int dpaymentssdk_globalbatchmgr_captureall(void* lpObj);
int 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckConnection Method (GlobalBatchMgr Class)

Checks the connection status to the Global Payments server and validates login information.

Syntax

ANSI (Cross Platform)
int CheckConnection();

Unicode (Windows)
INT CheckConnection();
int dpaymentssdk_globalbatchmgr_checkconnection(void* lpObj);
int CheckConnection();

Remarks

Returns "OK" in the BatchResponseApprovalCode property if a connection can be made to the Global Transport Gateway with the supplied UserId and Password otherwise the BatchResponseCode and BatchResponseMessage will indicate an error condition.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckSetup Method (GlobalBatchMgr Class)

Retrieves information about the merchant's current setup.

Syntax

ANSI (Cross Platform)
int CheckSetup();

Unicode (Windows)
INT CheckSetup();
int dpaymentssdk_globalbatchmgr_checksetup(void* lpObj);
int CheckSetup();

Remarks

This method will return information relating to the merchant's current setup as name/value pairs. By default, the class 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (GlobalBatchMgr Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* dpaymentssdk_globalbatchmgr_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetBatchSummary Method (GlobalBatchMgr Class)

Retrieves a summary of the current open batch for a merchant.

Syntax

ANSI (Cross Platform)
int GetBatchSummary();

Unicode (Windows)
INT GetBatchSummary();
int dpaymentssdk_globalbatchmgr_getbatchsummary(void* lpObj);
int 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 class's GetTransactionSummary method instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (GlobalBatchMgr Class)

Interrupt the current method.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
int dpaymentssdk_globalbatchmgr_interrupt(void* lpObj);
int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (GlobalBatchMgr Class)

Clears all properties to their default values.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int dpaymentssdk_globalbatchmgr_reset(void* lpObj);
int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (GlobalBatchMgr Class)

Fired when information is available about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(GlobalBatchMgrErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } GlobalBatchMgrErrorEventParams;
Unicode (Windows) virtual INT FireError(GlobalBatchMgrErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } GlobalBatchMgrErrorEventParams;
#define EID_GLOBALBATCHMGR_ERROR 1

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class GlobalBatchMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(GlobalBatchMgrErrorEventParams *e);
// Or, subclass GlobalBatchMgr and override this emitter function. virtual int FireError(GlobalBatchMgrErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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 Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(GlobalBatchMgrSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } GlobalBatchMgrSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(GlobalBatchMgrSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } GlobalBatchMgrSSLServerAuthenticationEventParams;
#define EID_GLOBALBATCHMGR_SSLSERVERAUTHENTICATION 2

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class GlobalBatchMgrSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSLServerAuthentication(GlobalBatchMgrSSLServerAuthenticationEventParams *e);
// Or, subclass GlobalBatchMgr and override this emitter function. virtual int FireSSLServerAuthentication(GlobalBatchMgrSSLServerAuthenticationEventParams *e) {...}

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 Class)

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(GlobalBatchMgrSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } GlobalBatchMgrSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(GlobalBatchMgrSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } GlobalBatchMgrSSLStatusEventParams;
#define EID_GLOBALBATCHMGR_SSLSTATUS 3

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);
class GlobalBatchMgrSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSLStatus(GlobalBatchMgrSSLStatusEventParams *e);
// Or, subclass GlobalBatchMgr and override this emitter function. virtual int FireSSLStatus(GlobalBatchMgrSSLStatusEventParams *e) {...}

Remarks

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

Status Event (GlobalBatchMgr Class)

Shows the progress of the Global Payments connection.

Syntax

ANSI (Cross Platform)
virtual int FireStatus(GlobalBatchMgrStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } GlobalBatchMgrStatusEventParams;
Unicode (Windows) virtual INT FireStatus(GlobalBatchMgrStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } GlobalBatchMgrStatusEventParams;
#define EID_GLOBALBATCHMGR_STATUS 4

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);
class GlobalBatchMgrStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Status(GlobalBatchMgrStatusEventParams *e);
// Or, subclass GlobalBatchMgr and override this emitter function. virtual int FireStatus(GlobalBatchMgrStatusEventParams *e) {...}

Remarks

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

Config Settings (GlobalBatchMgr Class)

The class 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 class, access to these internal properties is provided through the Config method.

GlobalBatchMgr Config Settings

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

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

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

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

SetupResultMode:   Indicates whether to return simple or detailed information with the CheckSetup method.

If set to "Advanced" (default), detailed setup information will be returned as name/value pairs in the SetupFields collection. If set to "Simple", a much smaller and simpler result will be returned in this same SetupFields collection.

TCPClient Config Settings

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

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

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

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

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

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

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

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

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

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

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

FirewallPort:   The TCP port for the FirewallHost;.

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

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

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

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

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

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

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

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

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

Note: This value is not applicable in macOS.

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

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

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

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

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

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

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

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

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

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

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

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

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

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

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

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

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

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

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

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.nsoftware.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

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

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

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

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

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class 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 class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class 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

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. 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-----

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

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

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

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

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

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class 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
Example values when SSLProvider is set to Internal: 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.

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

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (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 class 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 class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

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

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

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

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

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

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

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

When set, the class 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 class will only append, it will not overwrite previous values.

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

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

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

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class 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 class fails with an error.

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.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

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)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

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"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "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 rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

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

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

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

InBufferSize:   The size in bytes of the incoming queue of the socket.

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

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

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

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

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class 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

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • 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.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class 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.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (GlobalBatchMgr Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

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 class may also return one of the following error codes, which are inherited from other classes.

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 class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).