GlobalBatchMgr Module

Properties Methods Events Config Settings Errors

The GlobalBatchMgr module 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

DPaymentsSDK.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.
CheckConnection	This method checks the status of the connection to the Global Payments server and validates the UserId and Password login credentials.
CheckSetup	This method will return detailed information relating to the merchant's current setup as name/value pairs in the SetupFields collection.
GetBatchSummary	This method retrieves information about all of the transactions in the current open batch, and stores this information in the SummaryResults collection.

Property List

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


BatchResponse	Contains information about the current batch.
BenefitTransactions	Contains the transaction totals for Electronic Benefit (EBT) Cards.
CheckTransactions	Contains the transaction totals for electronic checks.
CreditTransactions	Contains the transaction totals for Credit Cards.
DebitTransactions	Contains the transaction totals for Debit Cards.
ForceClose	Forces a batch Capture even if there are mismatched transaction totals.
InquiryType	Indicates whether to perform an inquiry on the current batch or on the previous batch.
Password	Password for authentication with the Global Payments Server .
Proxy	A set of properties related to proxy access.
Server	Global Payments transaction server.
SetupFields	Contains list of fields returned by Global Payments, which reflect the current state of the merchant setup.
SSLAcceptServerCert	Instructs the module to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProvider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
SSLServerCert	The server certificate for the last established connection.
SummaryBeginDate	Optional filter for use when retrieving a batch summary.
SummaryEndDate	Optional filter for use when retrieving a batch summary.
SummaryResults	Contains summary results for all payment types in the current batch.
Timeout	The timeout for the module.
UserId	UserId for authentication with the Global Payments Server .
VendorNumber	The merchant's RP/Vendor number.

Method List

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


BatchInquiry	Retrieves the current state of the open batch.
CaptureAll	Marks the current batch for settlement.
CheckConnection	Checks the connection status to the Global Payments server and validates login information.
CheckSetup	Retrieves information about the merchant's current setup.
Config	Sets or retrieves a configuration setting.
GetBatchSummary	Retrieves a summary of the current open batch for a merchant.
Interrupt	This method interrupts the current method.
Reset	Clears all properties to their default values.

Event List

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


Error	Fired when information is available about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.
Status	Shows the progress of the Global Payments connection.

Config Settings

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


RawRequest	Returns the request sent to the server for debugging purposes.
RawResponse	Returns the response received from the server for debugging purposes.
SetupResultMode	Indicates whether to return simple or detailed information with the CheckSetup method.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the module whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the module binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

BatchResponse Property (GlobalBatchMgr Module)

Contains information about the current batch.

public var batchResponse: GlobalBatchResponse {
  get {...}
}


@property (nonatomic,readonly,assign,getter=batchResponseApprovalCode) NSString* batchResponseApprovalCode;

- (NSString*)batchResponseApprovalCode;

@property (nonatomic,readonly,assign,getter=batchResponseBatchNumber) NSString* batchResponseBatchNumber;

- (NSString*)batchResponseBatchNumber;

@property (nonatomic,readonly,assign,getter=batchResponseCode) NSString* batchResponseCode;

- (NSString*)batchResponseCode;

@property (nonatomic,readonly,assign,getter=batchResponseMessage) NSString* batchResponseMessage;

- (NSString*)batchResponseMessage;

@property (nonatomic,readonly,assign,getter=batchResponseMessageDetail) NSString* batchResponseMessageDetail;

- (NSString*)batchResponseMessageDetail;

@property (nonatomic,readonly,assign,getter=batchResponseNetTransAmount) NSString* batchResponseNetTransAmount;

- (NSString*)batchResponseNetTransAmount;

@property (nonatomic,readonly,assign,getter=batchResponseNetTransCount) int batchResponseNetTransCount;

- (int)batchResponseNetTransCount;

@property (nonatomic,readonly,assign,getter=batchResponseSettleDate) NSString* batchResponseSettleDate;

- (NSString*)batchResponseSettleDate;

Default Value

Remarks

This property is filled in response to a BatchInquiry, CaptureAll, or CheckConnection method call.


	Contains the transaction Authorization code.
	Indicates the number of the current batch.
	Contains the transaction result code from the Global Transport Gateway.
	Contains a human-readable response message concerning the processed transaction.
	Contains a formatted response message concerning the processed transaction.
	The net dollar amount of all transactions.
	This field contains the total number of transactions contained in the batch settlement.
	The date the batch was settled.

BenefitTransactions Property (GlobalBatchMgr Module)

Contains the transaction totals for Electronic Benefit (EBT) Cards.

Syntax

Swift
Objective-C

public var benefitTransactions: GlobalBatchTotals {
  get {...}
}


@property (nonatomic,readonly,assign,getter=benefitTransNetAmount) NSString* benefitTransNetAmount;

- (NSString*)benefitTransNetAmount;

@property (nonatomic,readonly,assign,getter=benefitTransNetCount) int benefitTransNetCount;

- (int)benefitTransNetCount;

@property (nonatomic,readonly,assign,getter=benefitTransRefundAmount) NSString* benefitTransRefundAmount;

- (NSString*)benefitTransRefundAmount;

@property (nonatomic,readonly,assign,getter=benefitTransRefundCount) int benefitTransRefundCount;

- (int)benefitTransRefundCount;

@property (nonatomic,readonly,assign,getter=benefitTransSaleAmount) NSString* benefitTransSaleAmount;

- (NSString*)benefitTransSaleAmount;

@property (nonatomic,readonly,assign,getter=benefitTransSaleCount) int benefitTransSaleCount;

- (int)benefitTransSaleCount;

Default Value

Remarks

This property contains the total sale amount, total refund amount, and net total amount for all EBT card transactions contained in the batch. If no EBT transactions were made with the GlobalBenefit class (and none were made with the merchant's virtual terminal) these BenefitTransaction properties will be empty.

This property is populated when calling BatchInquiry and CaptureAll.

CheckTransactions Property (GlobalBatchMgr Module)

Contains the transaction totals for electronic checks.

Syntax

Swift
Objective-C

public var checkTransactions: GlobalBatchTotals {
  get {...}
}


@property (nonatomic,readonly,assign,getter=checkTransNetAmount) NSString* checkTransNetAmount;

- (NSString*)checkTransNetAmount;

@property (nonatomic,readonly,assign,getter=checkTransNetCount) int checkTransNetCount;

- (int)checkTransNetCount;

@property (nonatomic,readonly,assign,getter=checkTransRefundAmount) NSString* checkTransRefundAmount;

- (NSString*)checkTransRefundAmount;

@property (nonatomic,readonly,assign,getter=checkTransRefundCount) int checkTransRefundCount;

- (int)checkTransRefundCount;

@property (nonatomic,readonly,assign,getter=checkTransSaleAmount) NSString* checkTransSaleAmount;

- (NSString*)checkTransSaleAmount;

@property (nonatomic,readonly,assign,getter=checkTransSaleCount) int checkTransSaleCount;

- (int)checkTransSaleCount;

Default Value

Remarks

This property contains a the total sale amount, total refund amount, and net total amount for all electronic check transactions contained in the batch. If no e-Check transactions were made using the merchant's virtual terminal, these CheckTransaction properties will be empty.

This property is populated when calling BatchInquiry and CaptureAll.

CreditTransactions Property (GlobalBatchMgr Module)

Contains the transaction totals for Credit Cards.

Syntax

Swift
Objective-C

public var creditTransactions: GlobalBatchTotals {
  get {...}
}


@property (nonatomic,readonly,assign,getter=creditTransNetAmount) NSString* creditTransNetAmount;

- (NSString*)creditTransNetAmount;

@property (nonatomic,readonly,assign,getter=creditTransNetCount) int creditTransNetCount;

- (int)creditTransNetCount;

@property (nonatomic,readonly,assign,getter=creditTransRefundAmount) NSString* creditTransRefundAmount;

- (NSString*)creditTransRefundAmount;

@property (nonatomic,readonly,assign,getter=creditTransRefundCount) int creditTransRefundCount;

- (int)creditTransRefundCount;

@property (nonatomic,readonly,assign,getter=creditTransSaleAmount) NSString* creditTransSaleAmount;

- (NSString*)creditTransSaleAmount;

@property (nonatomic,readonly,assign,getter=creditTransSaleCount) int creditTransSaleCount;

- (int)creditTransSaleCount;

Default Value

Remarks

This property contains a the total sale amount, total refund amount, and net total amount for all credit card transactions contained in the batch. If no Credit transactions were made with the GlobalCharge class (and none were made with the merchant's virtual terminal) these CreditTransaction properties will be empty.

This property is populated when calling BatchInquiry and CaptureAll.

DebitTransactions Property (GlobalBatchMgr Module)

Contains the transaction totals for Debit Cards.

Syntax

Swift
Objective-C

public var debitTransactions: GlobalBatchTotals {
  get {...}
}


@property (nonatomic,readonly,assign,getter=debitTransNetAmount) NSString* debitTransNetAmount;

- (NSString*)debitTransNetAmount;

@property (nonatomic,readonly,assign,getter=debitTransNetCount) int debitTransNetCount;

- (int)debitTransNetCount;

@property (nonatomic,readonly,assign,getter=debitTransRefundAmount) NSString* debitTransRefundAmount;

- (NSString*)debitTransRefundAmount;

@property (nonatomic,readonly,assign,getter=debitTransRefundCount) int debitTransRefundCount;

- (int)debitTransRefundCount;

@property (nonatomic,readonly,assign,getter=debitTransSaleAmount) NSString* debitTransSaleAmount;

- (NSString*)debitTransSaleAmount;

@property (nonatomic,readonly,assign,getter=debitTransSaleCount) int debitTransSaleCount;

- (int)debitTransSaleCount;

Default Value

Remarks

This property contains a the total sale amount, total refund amount, and net total amount for all debit card transactions contained in the batch. If no Debit transactions were made with the GlobalDebit class (and none were made with the merchant's virtual terminal) these DebitTransaction properties will be empty.

This property is populated when calling BatchInquiry and CaptureAll.

ForceClose Property (GlobalBatchMgr Module)

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

Syntax

Swift
Objective-C

public var forceClose: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=forceClose,setter=setForceClose:) BOOL forceClose;

- (BOOL)forceClose;
- (void)setForceClose :(BOOL)newForceClose;

Default Value

False

Remarks

Calling CaptureAll with ForceClose set to True will settle all transactions for all payment types in the current batch regardless of whether the totals match with the Global Payments server (which can happen if there are timeouts or discrepancies based on other connectivity issues). This function should only be used when the merchant's account is setup for "merchant-initiated" close on the Global Payments server and if a normal CaptureAll batch close request fails with a "MUST BALANCE NOW" response.

InquiryType Property (GlobalBatchMgr Module)

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

Syntax

Swift
Objective-C

public var inquiryType: GlobalBatchMgrInquiryTypes {
  get {...}
  set {...}
}

public enum GlobalBatchMgrInquiryTypes: Int32 {
  case itCurrentBatch = 0
  case itPreviousBatch = 1
}


@property (nonatomic,readwrite,assign,getter=inquiryType,setter=setInquiryType:) int inquiryType;

- (int)inquiryType;
- (void)setInquiryType :(int)newInquiryType;

Default Value

Remarks

This property is used by the BatchInquiry method to indicate whether you wish to retrieve results for the current open batch, or for the most recently closed batch. This property is not applicable for the GetBatchSummary method.

Password Property (GlobalBatchMgr Module)

Password for authentication with the Global Payments Server .

Syntax

Swift
Objective-C

public var password: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

Remarks

The Password will be supplied to you by Global Payments.

Proxy Property (GlobalBatchMgr Module)

A set of properties related to proxy access.

Syntax

Swift
Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

Default Value

Remarks

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

Server Property (GlobalBatchMgr Module)

Global Payments transaction server.

Syntax

Swift
Objective-C

public var server: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=server,setter=setServer:) NSString* server;

- (NSString*)server;
- (void)setServer :(NSString*)newServer;

Default Value

"https://api.globalpay.com"

Remarks

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

SetupFields Property (GlobalBatchMgr Module)

Contains list of fields returned by Global Payments, which reflect the current state of the merchant setup.

Syntax

Swift
Objective-C

public var setupFields: Array<GlobalSetupField> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=setupFieldCount) int setupFieldCount;

- (int)setupFieldCount;

- (NSString*)setupFieldName:(int)setupFieldIndex;

- (NSString*)setupFieldValue:(int)setupFieldIndex;

Default Value

Remarks

The fields returned by the Global Pay server will be dependent on the current merchant setup as well as whether you requested basic or advanced setup information. For instance, you may receive of "PaymentTypes", where the contains a list of the currently supported card types. "LiveUrl", "TestUrl", "Partner", "Vendor" and a other settings may also be contained in this collection.

SSLAcceptServerCert Property (GlobalBatchMgr Module)

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

Syntax

Swift
Objective-C

public var sslAcceptServerCert: Certificate {
  get {...}
  set {...}
}


@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertEffectiveDate) NSString* SSLAcceptServerCertEffectiveDate;

- (NSString*)SSLAcceptServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExpirationDate) NSString* SSLAcceptServerCertExpirationDate;

- (NSString*)SSLAcceptServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertExtendedKeyUsage) NSString* SSLAcceptServerCertExtendedKeyUsage;

- (NSString*)SSLAcceptServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprint) NSString* SSLAcceptServerCertFingerprint;

- (NSString*)SSLAcceptServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA1) NSString* SSLAcceptServerCertFingerprintSHA1;

- (NSString*)SSLAcceptServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertFingerprintSHA256) NSString* SSLAcceptServerCertFingerprintSHA256;

- (NSString*)SSLAcceptServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertIssuer) NSString* SSLAcceptServerCertIssuer;

- (NSString*)SSLAcceptServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKey) NSString* SSLAcceptServerCertPrivateKey;

- (NSString*)SSLAcceptServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyAvailable) BOOL SSLAcceptServerCertPrivateKeyAvailable;

- (BOOL)SSLAcceptServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPrivateKeyContainer) NSString* SSLAcceptServerCertPrivateKeyContainer;

- (NSString*)SSLAcceptServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKey) NSString* SSLAcceptServerCertPublicKey;

- (NSString*)SSLAcceptServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyAlgorithm) NSString* SSLAcceptServerCertPublicKeyAlgorithm;

- (NSString*)SSLAcceptServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertPublicKeyLength) int SSLAcceptServerCertPublicKeyLength;

- (int)SSLAcceptServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSerialNumber) NSString* SSLAcceptServerCertSerialNumber;

- (NSString*)SSLAcceptServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSignatureAlgorithm) NSString* SSLAcceptServerCertSignatureAlgorithm;

- (NSString*)SSLAcceptServerCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStore,setter=setSSLAcceptServerCertStore:) NSString* SSLAcceptServerCertStore;

- (NSString*)SSLAcceptServerCertStore;
- (void)setSSLAcceptServerCertStore :(NSString*)newSSLAcceptServerCertStore;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreB,setter=setSSLAcceptServerCertStoreB:) NSData* SSLAcceptServerCertStoreB;

- (NSData*)SSLAcceptServerCertStoreB;
- (void)setSSLAcceptServerCertStoreB :(NSData*)newSSLAcceptServerCertStore;
@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStorePassword,setter=setSSLAcceptServerCertStorePassword:) NSString* SSLAcceptServerCertStorePassword;

- (NSString*)SSLAcceptServerCertStorePassword;
- (void)setSSLAcceptServerCertStorePassword :(NSString*)newSSLAcceptServerCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertStoreType,setter=setSSLAcceptServerCertStoreType:) int SSLAcceptServerCertStoreType;

- (int)SSLAcceptServerCertStoreType;
- (void)setSSLAcceptServerCertStoreType :(int)newSSLAcceptServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertSubjectAltNames) NSString* SSLAcceptServerCertSubjectAltNames;

- (NSString*)SSLAcceptServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintMD5) NSString* SSLAcceptServerCertThumbprintMD5;

- (NSString*)SSLAcceptServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA1) NSString* SSLAcceptServerCertThumbprintSHA1;

- (NSString*)SSLAcceptServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertThumbprintSHA256) NSString* SSLAcceptServerCertThumbprintSHA256;

- (NSString*)SSLAcceptServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsage) NSString* SSLAcceptServerCertUsage;

- (NSString*)SSLAcceptServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertUsageFlags) int SSLAcceptServerCertUsageFlags;

- (int)SSLAcceptServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLAcceptServerCertVersion) NSString* SSLAcceptServerCertVersion;

- (NSString*)SSLAcceptServerCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertSubject,setter=setSSLAcceptServerCertSubject:) NSString* SSLAcceptServerCertSubject;

- (NSString*)SSLAcceptServerCertSubject;
- (void)setSSLAcceptServerCertSubject :(NSString*)newSSLAcceptServerCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

Default Value

Remarks

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

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

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

SSLCert Property (GlobalBatchMgr Module)

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

Syntax

Swift
Objective-C

public var sslCert: Certificate {
  get {...}
  set {...}
}


@property (nonatomic,readonly,assign,getter=SSLCertEffectiveDate) NSString* SSLCertEffectiveDate;

- (NSString*)SSLCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLCertExpirationDate) NSString* SSLCertExpirationDate;

- (NSString*)SSLCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLCertExtendedKeyUsage) NSString* SSLCertExtendedKeyUsage;

- (NSString*)SSLCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprint) NSString* SSLCertFingerprint;

- (NSString*)SSLCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA1) NSString* SSLCertFingerprintSHA1;

- (NSString*)SSLCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA256) NSString* SSLCertFingerprintSHA256;

- (NSString*)SSLCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertIssuer) NSString* SSLCertIssuer;

- (NSString*)SSLCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKey) NSString* SSLCertPrivateKey;

- (NSString*)SSLCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyAvailable) BOOL SSLCertPrivateKeyAvailable;

- (BOOL)SSLCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyContainer) NSString* SSLCertPrivateKeyContainer;

- (NSString*)SSLCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKey) NSString* SSLCertPublicKey;

- (NSString*)SSLCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyAlgorithm) NSString* SSLCertPublicKeyAlgorithm;

- (NSString*)SSLCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyLength) int SSLCertPublicKeyLength;

- (int)SSLCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLCertSerialNumber) NSString* SSLCertSerialNumber;

- (NSString*)SSLCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLCertSignatureAlgorithm) NSString* SSLCertSignatureAlgorithm;

- (NSString*)SSLCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLCertSubjectAltNames) NSString* SSLCertSubjectAltNames;

- (NSString*)SSLCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintMD5) NSString* SSLCertThumbprintMD5;

- (NSString*)SSLCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA1) NSString* SSLCertThumbprintSHA1;

- (NSString*)SSLCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA256) NSString* SSLCertThumbprintSHA256;

- (NSString*)SSLCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertUsage) NSString* SSLCertUsage;

- (NSString*)SSLCertUsage;

@property (nonatomic,readonly,assign,getter=SSLCertUsageFlags) int SSLCertUsageFlags;

- (int)SSLCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLCertVersion) NSString* SSLCertVersion;

- (NSString*)SSLCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

Remarks

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

SSLProvider Property (GlobalBatchMgr Module)

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

Syntax

Swift
Objective-C

public var sslProvider: GlobalBatchMgrSSLProviders {
  get {...}
  set {...}
}

public enum GlobalBatchMgrSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}


@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the 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 as follows:


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

Additional Notes

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

When Automatic is selected, the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCert Property (GlobalBatchMgr Module)

The server certificate for the last established connection.

Syntax

Swift
Objective-C

public var sslServerCert: Certificate {
  get {...}
}


@property (nonatomic,readonly,assign,getter=SSLServerCertEffectiveDate) NSString* SSLServerCertEffectiveDate;

- (NSString*)SSLServerCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExpirationDate) NSString* SSLServerCertExpirationDate;

- (NSString*)SSLServerCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLServerCertExtendedKeyUsage) NSString* SSLServerCertExtendedKeyUsage;

- (NSString*)SSLServerCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprint) NSString* SSLServerCertFingerprint;

- (NSString*)SSLServerCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA1) NSString* SSLServerCertFingerprintSHA1;

- (NSString*)SSLServerCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertFingerprintSHA256) NSString* SSLServerCertFingerprintSHA256;

- (NSString*)SSLServerCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertIssuer) NSString* SSLServerCertIssuer;

- (NSString*)SSLServerCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKey) NSString* SSLServerCertPrivateKey;

- (NSString*)SSLServerCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyAvailable) BOOL SSLServerCertPrivateKeyAvailable;

- (BOOL)SSLServerCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLServerCertPrivateKeyContainer) NSString* SSLServerCertPrivateKeyContainer;

- (NSString*)SSLServerCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKey) NSString* SSLServerCertPublicKey;

- (NSString*)SSLServerCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyAlgorithm) NSString* SSLServerCertPublicKeyAlgorithm;

- (NSString*)SSLServerCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertPublicKeyLength) int SSLServerCertPublicKeyLength;

- (int)SSLServerCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLServerCertSerialNumber) NSString* SSLServerCertSerialNumber;

- (NSString*)SSLServerCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLServerCertSignatureAlgorithm) NSString* SSLServerCertSignatureAlgorithm;

- (NSString*)SSLServerCertSignatureAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLServerCertStore) NSString* SSLServerCertStore;

- (NSString*)SSLServerCertStore;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreB) NSData* SSLServerCertStoreB;

- (NSData*)SSLServerCertStoreB;
@property (nonatomic,readonly,assign,getter=SSLServerCertStorePassword) NSString* SSLServerCertStorePassword;

- (NSString*)SSLServerCertStorePassword;

@property (nonatomic,readonly,assign,getter=SSLServerCertStoreType) int SSLServerCertStoreType;

- (int)SSLServerCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubjectAltNames) NSString* SSLServerCertSubjectAltNames;

- (NSString*)SSLServerCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintMD5) NSString* SSLServerCertThumbprintMD5;

- (NSString*)SSLServerCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA1) NSString* SSLServerCertThumbprintSHA1;

- (NSString*)SSLServerCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLServerCertThumbprintSHA256) NSString* SSLServerCertThumbprintSHA256;

- (NSString*)SSLServerCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsage) NSString* SSLServerCertUsage;

- (NSString*)SSLServerCertUsage;

@property (nonatomic,readonly,assign,getter=SSLServerCertUsageFlags) int SSLServerCertUsageFlags;

- (int)SSLServerCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLServerCertVersion) NSString* SSLServerCertVersion;

- (NSString*)SSLServerCertVersion;

@property (nonatomic,readonly,assign,getter=SSLServerCertSubject) NSString* SSLServerCertSubject;

- (NSString*)SSLServerCertSubject;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

Default Value

Remarks

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

SSLServerCert is reset every time a new connection is attempted.

SummaryBeginDate Property (GlobalBatchMgr Module)

Optional filter for use when retrieving a batch summary.

Syntax

Swift
Objective-C

public var summaryBeginDate: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=summaryBeginDate,setter=setSummaryBeginDate:) NSString* summaryBeginDate;

- (NSString*)summaryBeginDate;
- (void)setSummaryBeginDate :(NSString*)newSummaryBeginDate;

Default Value

Remarks

The begin date of the date range may be entered in "MM/DD/YYYY" format if you wish. This date will be converted by the Global system to: "MM/DD/YYYYT00:00:00:0000AM."

SummaryEndDate Property (GlobalBatchMgr Module)

Optional filter for use when retrieving a batch summary.

Syntax

Swift
Objective-C

public var summaryEndDate: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=summaryEndDate,setter=setSummaryEndDate:) NSString* summaryEndDate;

- (NSString*)summaryEndDate;
- (void)setSummaryEndDate :(NSString*)newSummaryEndDate;

Default Value

Remarks

The end date of the date range may be entered in "MM/DD/YYYY" format if you wish. This date will be converted by the Global system to "MM/DD/YYYYT12:59:59:9999PM".

SummaryResults Property (GlobalBatchMgr Module)

Contains summary results for all payment types in the current batch.

Syntax

Swift
Objective-C

public var summaryResults: Array<GlobalSummaryResult> {
  get {...}
}


@property (nonatomic,readonly,assign,getter=summaryResultCount) int summaryResultCount;

- (int)summaryResultCount;

- (NSString*)summaryResultAuthorizationAmount:(int)summaryIndex;

- (int)summaryResultAuthorizationCount:(int)summaryIndex;

- (NSString*)summaryResultCaptureAmount:(int)summaryIndex;

- (int)summaryResultCaptureCount:(int)summaryIndex;

- (NSString*)summaryResultForceCaptureAmount:(int)summaryIndex;

- (int)summaryResultForceCaptureCount:(int)summaryIndex;

- (NSString*)summaryResultPaymentType:(int)summaryIndex;

- (NSString*)summaryResultPostAuthAmount:(int)summaryIndex;

- (int)summaryResultPostAuthCount:(int)summaryIndex;

- (NSString*)summaryResultRefundAmount:(int)summaryIndex;

- (int)summaryResultRefundCount:(int)summaryIndex;

- (NSString*)summaryResultRepeatSaleAmount:(int)summaryIndex;

- (int)summaryResultRepeatSaleCount:(int)summaryIndex;

- (NSString*)summaryResultSaleAmount:(int)summaryIndex;

- (int)summaryResultSaleCount:(int)summaryIndex;

- (int)summaryResultTotalCount:(int)summaryIndex;

Default Value

Remarks

This property contains the results after a successful call to the GetBatchSummary method. Each GlobalSummaryResult in the collection will contain a summary for the payment type specified by the field. This includes the total dollar amounts and transaction counts of all the Sale, Refund, Force, Auth-only, and Recurring transactions, as well as the total number of transactions made for that particular .

Timeout Property (GlobalBatchMgr Module)

The timeout for the module.

Syntax

Swift
Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

Remarks

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

If Timeout is set to a positive value, the 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 .

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

The default value for the Timeout property is 60 seconds.

UserId Property (GlobalBatchMgr Module)

UserId for authentication with the Global Payments Server .

Syntax

Swift
Objective-C

public var userId: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=userId,setter=setUserId:) NSString* userId;

- (NSString*)userId;
- (void)setUserId :(NSString*)newUserId;

Default Value

Remarks

The UserId will be supplied to you by Global Payments.

VendorNumber Property (GlobalBatchMgr Module)

The merchant's RP/Vendor number.

Syntax

Swift
Objective-C

public var vendorNumber: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=vendorNumber,setter=setVendorNumber:) NSString* vendorNumber;

- (NSString*)vendorNumber;
- (void)setVendorNumber :(NSString*)newVendorNumber;

Default Value

Remarks

The Vendor number is also known as the "RP Number" or "RPNum", and is required by the GetBatchSummary method to retrieve information about transactions in the current open batch. If you do not know your Vendor/RPNum you may log into your Global Payments virtual terminal, or simply use the CheckSetup method to find it.

BatchInquiry Method (GlobalBatchMgr Module)

Retrieves the current state of the open batch.

Syntax

Swift
Objective-C

public func batchInquiry() throws -> Void

- (void)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.

CaptureAll Method (GlobalBatchMgr Module)

Marks the current batch for settlement.

Syntax

Swift
Objective-C

public func captureAll() throws -> Void

- (void)captureAll;

Remarks

This operation will settle all transactions for all payment types in the current batch. This function should only be used when the merchant's account is setup for "merchant-initiated" close on the Global Payments server. The results of the CaptureAll will be returned in the BatchResponse property, and any transaction totals that may be returned will be contained in the CreditTransactions, DebitTransactions, BenefitTransactions, and CheckTransactions properties.

CheckConnection Method (GlobalBatchMgr Module)

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

Syntax

Swift
Objective-C

public func checkConnection() throws -> Void

- (void)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.

CheckSetup Method (GlobalBatchMgr Module)

Retrieves information about the merchant's current setup.

Syntax

Swift
Objective-C

public func checkSetup() throws -> Void

- (void)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.

Config Method (GlobalBatchMgr Module)

Sets or retrieves a configuration setting.

Syntax

Swift
Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

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.

GetBatchSummary Method (GlobalBatchMgr Module)

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

Syntax

Swift
Objective-C

public func getBatchSummary() throws -> Void

- (void)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.

Interrupt Method (GlobalBatchMgr Module)

This method interrupts the current method.

Syntax

Swift
Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

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

Reset Method (GlobalBatchMgr Module)

Clears all properties to their default values.

Syntax

Swift
Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method clears all properties to their default values.

Error Event (GlobalBatchMgr Module)

Fired when information is available about errors during data delivery.

Syntax

Swift
Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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

Fired after the server presents its certificate to the client.

Syntax

Swift
Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

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

Fired when secure connection progress messages are available.

Syntax

Swift
Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

Remarks

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

Status Event (GlobalBatchMgr Module)

Shows the progress of the Global Payments connection.

Syntax

Swift
Objective-C

func onStatus(message: String)

- (void)onStatus:(NSString*)message;

Remarks

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

Certificate Type

This is the digital certificate being used.

Remarks

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

The following fields are available:

Fields

effectiveDate
String (read-only)
Default Value: ""

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

23-Jan-2000 15:00:00.

expirationDate
String (read-only)
Default Value: ""

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

23-Jan-2001 15:00:00.

extendedKeyUsage
String (read-only)
Default Value: ""

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

fingerprint
String (read-only)
Default Value: ""

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

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

fingerprintSHA1
String (read-only)
Default Value: ""

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

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

fingerprintSHA256
String (read-only)
Default Value: ""

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

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

issuer
String (read-only)
Default Value: ""

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

privateKey
String (read-only)
Default Value: ""

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

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

privateKeyAvailable
Bool (read-only)
Default Value: False

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

privateKeyContainer
String (read-only)
Default Value: ""

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

publicKey
String (read-only)
Default Value: ""

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

publicKeyAlgorithm
String (read-only)
Default Value: ""

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

publicKeyLength
Int32 (read-only)
Default Value: 0

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

serialNumber
String (read-only)
Default Value: ""

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

signatureAlgorithm
String (read-only)
Default Value: ""

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

storeB
Data
Default Value: "MY"

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

store
String
Default Value: "MY"

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

storePassword
String
Default Value: ""

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

storeType
CertStoreTypes
Default Value: 0

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 and set 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.

subjectAltNames
String (read-only)
Default Value: ""

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

thumbprintMD5
String (read-only)
Default Value: ""

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

thumbprintSHA1
String (read-only)
Default Value: ""

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

thumbprintSHA256
String (read-only)
Default Value: ""

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

usage
String (read-only)
Default Value: ""

The text description of .

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

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

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

usageFlags
Int32 (read-only)
Default Value: 0

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


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

Please see the property for a text representation of .

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

version
String (read-only)
Default Value: ""

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

subject
String
Default Value: ""

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=example@email.com". Common fields and their meanings are as follows:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

encodedB
Data
Default Value: ""

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

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

encoded
String
Default Value: ""

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

Constructors

public init()

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

public init(encoded: )

Parses Encoded as an X.509 public key.

public init(storeType: , store: , storePassword: , subject: )

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

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

public init(storeType: , store: , storePassword: , subject: )

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

GlobalBatchResponse Type

The response from a batch management transaction.

Remarks

This type will contain a response to a batch settlement, batch inquiry, or connection check.

The following fields are available:

ApprovalCode
BatchNumber
Code
Message
MessageDetail
NetTransAmount
NetTransCount
SettleDate

Fields

approvalCode
String (read-only)
Default Value: ""

Contains the transaction authorization code from the card issuer.

For approved transaction responses ( 0 or 200) the Global Transport Gateway sends a 6-character approval code in the property and a human-readable approval message in the property. In the case of a decline, the will contain an error message. Your application should display the as part of the approval message for an approved transaction. For declined responses, the 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 , , and will indicate the problem. For batch settlement responses it will contain the approval code. For all other transaction responses will remain empty.

batchNumber
String (read-only)
Default Value: ""

Indicates the number of the current batch.

If this is a response to a BatchInquiry transaction, this 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.

code
String (read-only)
Default Value: ""

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


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

A Partial Authorization transaction occurs when the issuer authorizes part of the sale amount on a pre-paid credit card. The transaction is approved for an amount less than the original TransactionAmount, and the customer must tender the remaining balance with another form of payment. When a transaction is partially approved, the will contain "200", the will contain "Partial Approval", and the will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the will contain the amount of the transaction that was authorized, and the 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.

message
String (read-only)
Default Value: ""

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

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

messageDetail
String (read-only)
Default Value: ""

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

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

netTransAmount
String (read-only)
Default Value: ""

The net dollar amount of all transactions.

This is the total transaction amount of the settlement, minus all refunds. If positive it indicates a payment to the merchant. If negative it means more refunds than sales were contained in the batch, and the merchant will be charged. Note that a void transaction DOES count towards the total , but a Refund or Credit subtracts from it.

For instance, a batch containing one $10 transaction and one $10 void will have a of "20.00". However, a batch containing one $10 transaction and one $3 refund will have a of "7.00". In either case, the will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

netTransCount
Int32 (read-only)
Default Value: 0

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

settleDate
String (read-only)
Default Value: ""

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

Constructors

public init()

GlobalBatchTotals Type

Contains the transaction totals for a particular transaction type.

Remarks

This type contains the net transaction amount, total refund amount, and total sale amount that are contained in the batch for a particular transaction type.

The following fields are available:

NetAmount
NetCount
RefundAmount
RefundCount
SaleAmount
SaleCount

Fields

netAmount
String (read-only)
Default Value: ""

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

This is the total amount of all the transactions (for this transaction type) in the settlement - including sales, voids, captures, and forces - minus all refunds/credits. If positive it indicates net payment to the merchant. If negative it means more refunds than sales were contained in the batch, and a net loss for the merchant. Note that a Void transaction DOES count towards the total , 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 of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a of "7.00". In either case, the will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

netCount
Int32 (read-only)
Default Value: 0

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

refundAmount
String (read-only)
Default Value: ""

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

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

refundCount
Int32 (read-only)
Default Value: 0

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

saleAmount
String (read-only)
Default Value: ""

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

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

saleCount
Int32 (read-only)
Default Value: 0

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

Constructors

public init()

GlobalSetupField Type

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

Remarks

The fields returned by the Global Pay server will be dependent on the current merchant setup as well as whether you requested basic or advanced setup information. For instance, you may receive of "PaymentTypes", and the will contain a list of the currently supported card types. "LiveUrl", "TestUrl", "Partner", "Vendor" and other settings may also be returned.

The following fields are available:

FieldName
Value

Fields

fieldName
String (read-only)
Default Value: ""

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

value
String (read-only)
Default Value: ""

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

Constructors

public init()

public init(fieldName: , value: )

GlobalSummaryResult Type

Contains a summary for a single payment type.

Remarks

This type will contain a summary for the payment type specified by the field. This includes the total dollar amounts and transaction counts of all the Sale, Refund, Force, Auth-only, and Recurring transactions, as well as the total number of transactions made for that particular .

The following fields are available:

AuthorizationAmount
AuthorizationCount
CaptureAmount
CaptureCount
ForceCaptureAmount
ForceCaptureCount
PaymentType
PostAuthAmount
PostAuthCount
RefundAmount
RefundCount
RepeatSaleAmount
RepeatSaleCount
SaleAmount
SaleCount
TotalCount

Fields

authorizationAmount
String (read-only)
Default Value: ""

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

authorizationCount
Int32 (read-only)
Default Value: 0

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

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

captureAmount
String (read-only)
Default Value: ""

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

captureCount
Int32 (read-only)
Default Value: 0

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

forceCaptureAmount
String (read-only)
Default Value: ""

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

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

forceCaptureCount
Int32 (read-only)
Default Value: 0

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

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

paymentType
String (read-only)
Default Value: ""

The type of transactions being summarized.

This field varies based on the value specified via SearchCriteriaCardBreakdown. When set to 'False', PaymentType will be set to transaction type returned in the response such as "Sale", "Return", "Force", etc.

When set to 'True', PaymentType will be set to the card and transaction type returned in the response and separated by " - " such as "VISA - Force", "MasterCard - Return", "Discover - Sale", etc.

postAuthAmount
String (read-only)
Default Value: ""

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

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

postAuthCount
Int32 (read-only)
Default Value: 0

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

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

refundAmount
String (read-only)
Default Value: ""

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

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

refundCount
Int32 (read-only)
Default Value: 0

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

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

repeatSaleAmount
String (read-only)
Default Value: ""

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

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

repeatSaleCount
Int32 (read-only)
Default Value: 0

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

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

saleAmount
String (read-only)
Default Value: ""

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

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

saleCount
Int32 (read-only)
Default Value: 0

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

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

totalCount
Int32 (read-only)
Default Value: 0

Contains the total count of all transactions for the indicated .

Constructors

public init()

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

The following fields are available:

AuthScheme
AutoDetect
Password
Port
Server
SSL
User

Fields

authScheme
ProxyAuthSchemes
Default Value: 0

The type of authorization to perform when connecting to the proxy. This is used only when the and properties are set.

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

By default, is authBasic (0), and if the and properties are set, the class will attempt basic authentication.

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

If 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 is set to authNtlm (4), NTLM authentication will be used.

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

autoDetect
Bool
Default Value: False

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

password
String
Default Value: ""

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

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

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

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

port
Int32
Default Value: 80

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

server
String
Default Value: ""

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

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

ssl
ProxySSLTypes
Default Value: 0

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


psAutomatic (0)	Default setting. If the URL is an `https` URL, the 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.

user
String
Default Value: ""

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

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

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

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

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

Config Settings (GlobalBatchMgr Module)

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 .

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.

Possible values are as follows:


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

Note: This setting is provided for use by 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 .

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.

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

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

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

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

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

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

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

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

MaxTransferRate: The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.example.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

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

By default, this configuration setting is set to False.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the 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 as follows:


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 configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is False, as it is useful only for debugging purposes.

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

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

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). OpenSSL recommends the use of 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 the following sequences:

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

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

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

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. 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.

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

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

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

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

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

When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

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

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

When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

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

Note: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

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

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

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

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

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

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

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

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

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

The special value "*" means that the 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 include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when SSLProvider is set to Internalinclude the following:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");

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

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

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

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


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

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

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider), please be aware of the following notes:

The platform provider is available only on Windows 11/Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the 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 configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is by default, but it can be set to to enable the extension.

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

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

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

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

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

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

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

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

SSLNegotiatedCipher: Returns the negotiated cipher suite.

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

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

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

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

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

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g., TCPServer), this is a per-connection configuration 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 ORed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown certificate authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown certificate authority revocation status.
0x00000800	Ignore unknown root revocation status.
0x00008000	Allow test root certificate.
0x00004000	Trust test root certificate.
0x80000000	Ignore non-matching CN (certificate CN non-matching server name).

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

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

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and 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 configuration setting should be set only 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 configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

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

This configuration 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 configuration setting. If the server certificate signature algorithm is unsupported, the class .

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

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

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

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only 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 configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"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 configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only 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 that 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 User Datagram Protocol (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 Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the InBufferSize setting can provide significant improvements in performance.

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. In some cases, increasing the value of the OutBufferSize setting can provide significant improvements in performance.

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:


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

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


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

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.

MaskSensitiveData: 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 to mask sensitive data. The default is .

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.

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

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

Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (GlobalBatchMgr Module)

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.

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 nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot 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] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is 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 is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).