GlobalBenefit Module

Properties Methods Events Config Settings Errors

The GlobalBenefit module is used to authorize Electronic Benefits Transfer (EBT) transactions with the Global Payments system, using the Global Transport Direct API. This module is supported in the Retail and Restaurant environments, and allows for simple, direct, secure communication to the Global Transport gateway through a standard Internet connection. An EBT transaction is similar to a Debit transaction, using a PIN and Key Sequence Number (KSN), but is used for Food Stamp or Cash Benefit programs.

Syntax

DPaymentsSDK.Globalbenefit

Remarks

An EBT Card (also known as Cash Benefit Card or Food Stamp Card) works similar to a bank debit card. EBT is a special application of electronic funds transfer (EFT), or debit card technology, which takes money directly from one account and transfers it to another (credit cards, by comparison, simply record a sale for payment later).

There are just a few steps to setting up the class and sending transactions. First, set the UserId and Password, making sure that EBT transactions are allowed for your login credentials. If you're submitting test transaction and are using a test account, set the Server to the certification URL ("https://certapia.globalpay.com").

To send a transaction under normal circumstances, Track2 data should be read from the EBT card and placed in the CardMagneticStripe property. The CardEntryDataSource property should be set to edsMagneticStripe, and the EncryptedPIN and KSN properties should be filled with the encrypted PIN and key sequence number returned from your PIN pad. If the card reader is unable to read the magnetic stripe, card info may be manually added in the CardNumber, CardExpMonth, and CardExpYear properties, (and set the CardEntryDataSource property to edsManuallyEntered), but only for Food Stamp Transactions. Cash Benefit transactions may not be manually keyed.

Now simply set the TransactionAmount and call the Sale method to charge the card. You may also Refund funds back to the card (Food Stamp BenefitType only), as well as send a BalanceInquiry. Voice authorizations for Food Stamp transactions may be sent using the VoucherSale method.

The status of any of the above transactions will be stored in the ResponseCode property, with human-readable text appearing in ResponseText. Like the GlobalCharge class, there are several other Response properties which will contain data that should be logged.

EBT regulations require that all customer receipts include the last 4 digits of the CardNumber and the ResponseTransactionId, as well as the available balance for the account accessed. Balances are returned in the ResponseFoodStampBalance and ResponseCashBenefitsBalance properties.

EBT card transactions are instant funds transfers. There is no block placed on the debit card, funds are immediately removed and sent to the merchant. Therefore, there is no ability to capture, void, or reverse EBT transactions. You must use the Refund method to return funds to a customer's card - but only for Food Stamp transactions. Cash Benefit Refund transactions are not allowed. Unlike the GlobalCharge class's Refund method, the CardMagneticStripe, EncryptedPIN, and KSN are required in addition to the PNRef parameter, which identifies the transaction you're issuing a refund for.

Property List

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


BenefitType	Indicates whether the EBT card is a Food Stamps card or Cash Benefits card.
Card	Contains the customer's credit card information.
CashBack	Optional cash back amount to return to the customer.
CustomerName	The cardholder's name as it appears on the card.
EncryptedPIN	DUKPT DES encrypted pin block, retrieved from a PIN pad.
InvoiceNumber	Optional invoice tracking number.
KSN	Clear-text Key Serial Number retrieved from a PIN pad.
Password	Password for authentication with the Global Payments Server .
Proxy	This property includes a set of properties related to proxy access.
RegisterNumber	A number that uniquely identifies the register or computer on which the transaction was performed.
Response	Contains the response to an EBT transaction.
Server	Global Payments transaction server.
SSLAcceptServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/base64 encoded).
Timeout	A timeout for the module.
TransactionAmount	Amount to be charged from (or refunded to) the card.
UserId	UserId for authentication with the Global Payments Server .

Method List

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


BalanceInquiry	Retrieves the current balances of Food Stamp and Cash Benefit accounts on an EBT card.
Config	Sets or retrieves a configuration setting.
Interrupt	Interrupt the current method.
Refund	Submits a food stamp credit transaction, returning funds to an EBT card.
Reset	Clears all properties to their default values.
Sale	Submits a sale transaction for an Electronic Benefits (EBT) card.
VoucherSale	Used to clear (force) a food stamp voucher that was previously voice-authorized.

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	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
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.
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 certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Tells the module whether or not to use the system security libraries or an internal implementation.

BenefitType Property (GlobalBenefit Module)

Indicates whether the EBT card is a Food Stamps card or Cash Benefits card.

public var benefitType: GlobalbenefitBenefitTypes {
  get {...}
  set {...}
}

public enum GlobalbenefitBenefitTypes: Int32 {
  case btCashBenefits = 0
  case btFoodStamps = 1
}


@property (nonatomic,readwrite,assign,getter=benefitType,setter=setBenefitType:) int benefitType;

- (int)benefitType;
- (void)setBenefitType :(int)newBenefitType;

Default Value

Remarks

Available Benefit Types include:


btCashBenefits (0)	Cash benefits card. May be used like a debit card, and the customer may receive cash back. However, Refund transactions are not supported.
btFoodStamps (1)	Food Stamps card. Works like a debit card, but the customer may not purchase non-food related items (including alcohol), or receive cash back.

Card Property (GlobalBenefit Module)

Contains the customer's credit card information.

Syntax

Swift
Objective-C

public var card: CCCard {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=cardType,setter=setCardType:) int cardType;

- (int)cardType;
- (void)setCardType :(int)newCardType;

@property (nonatomic,readwrite,assign,getter=cardCVVData,setter=setCardCVVData:) NSString* cardCVVData;

- (NSString*)cardCVVData;
- (void)setCardCVVData :(NSString*)newCardCVVData;

@property (nonatomic,readwrite,assign,getter=cardCVVPresence,setter=setCardCVVPresence:) int cardCVVPresence;

- (int)cardCVVPresence;
- (void)setCardCVVPresence :(int)newCardCVVPresence;

@property (nonatomic,readwrite,assign,getter=cardEntryDataSource,setter=setCardEntryDataSource:) int cardEntryDataSource;

- (int)cardEntryDataSource;
- (void)setCardEntryDataSource :(int)newCardEntryDataSource;

@property (nonatomic,readwrite,assign,getter=cardExpMonth,setter=setCardExpMonth:) int cardExpMonth;

- (int)cardExpMonth;
- (void)setCardExpMonth :(int)newCardExpMonth;

@property (nonatomic,readwrite,assign,getter=cardExpYear,setter=setCardExpYear:) int cardExpYear;

- (int)cardExpYear;
- (void)setCardExpYear :(int)newCardExpYear;

@property (nonatomic,readwrite,assign,getter=cardIsEncrypted,setter=setCardIsEncrypted:) BOOL cardIsEncrypted;

- (BOOL)cardIsEncrypted;
- (void)setCardIsEncrypted :(BOOL)newCardIsEncrypted;

@property (nonatomic,readwrite,assign,getter=cardMagneticStripe,setter=setCardMagneticStripe:) NSString* cardMagneticStripe;

- (NSString*)cardMagneticStripe;
- (void)setCardMagneticStripe :(NSString*)newCardMagneticStripe;

@property (nonatomic,readwrite,assign,getter=cardNumber,setter=setCardNumber:) NSString* cardNumber;

- (NSString*)cardNumber;
- (void)setCardNumber :(NSString*)newCardNumber;

Default Value

Remarks

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

CashBack Property (GlobalBenefit Module)

Optional cash back amount to return to the customer.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=cashBack,setter=setCashBack:) NSString* cashBack;

- (NSString*)cashBack;
- (void)setCashBack :(NSString*)newCashBack;

Default Value

Remarks

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

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

CustomerName Property (GlobalBenefit Module)

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

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=customerName,setter=setCustomerName:) NSString* customerName;

- (NSString*)customerName;
- (void)setCustomerName :(NSString*)newCustomerName;

Default Value

Remarks

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

EncryptedPIN Property (GlobalBenefit Module)

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

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=encryptedPIN,setter=setEncryptedPIN:) NSString* encryptedPIN;

- (NSString*)encryptedPIN;
- (void)setEncryptedPIN :(NSString*)newEncryptedPIN;

Default Value

Remarks

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

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

class.UserId = "4dpayments_retail" class.Password = "Passw0rd" class.CardMagneticStripe = "9999999800002773=05121015432112345678" class.CardEntryDataSource = edsMagneticStripe class.TransactionAmount = "25.00" class.EncryptedPIN = "623F36B53CC18393" class.KSN = "000000008F000021" class.CashBack = "5.00" class.Sale()

InvoiceNumber Property (GlobalBenefit Module)

Optional invoice tracking number.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=invoiceNumber,setter=setInvoiceNumber:) NSString* invoiceNumber;

- (NSString*)invoiceNumber;
- (void)setInvoiceNumber :(NSString*)newInvoiceNumber;

Default Value

Remarks

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

KSN Property (GlobalBenefit Module)

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

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=KSN,setter=setKSN:) NSString* KSN;

- (NSString*)KSN;
- (void)setKSN :(NSString*)newKSN;

Default Value

Remarks

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

Password Property (GlobalBenefit 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 (GlobalBenefit Module)

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

RegisterNumber Property (GlobalBenefit Module)

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

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=registerNumber,setter=setRegisterNumber:) NSString* registerNumber;

- (NSString*)registerNumber;
- (void)setRegisterNumber :(NSString*)newRegisterNumber;

Default Value

Remarks

This may be up to 10 alphanumeric characters in length.

Response Property (GlobalBenefit Module)

Contains the response to an EBT transaction.

Syntax

Swift
Objective-C

public var response: GlobalBenefitResponse {
  get {...}
}


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

- (NSString*)responseApprovalCode;

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

- (NSString*)responseBatchNumber;

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

- (NSString*)responseCardType;

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

- (NSString*)responseCashBenefitsBalance;

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

- (NSString*)responseCode;

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

- (NSString*)responseData;

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

- (NSString*)responseFoodStampBalance;

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

- (NSString*)responseHostCode;

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

- (NSString*)responseInvoiceNumber;

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

- (NSString*)responseMerchantCode;

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

- (NSString*)responseMessage;

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

- (NSString*)responseMessageDetail;

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

- (NSString*)responsePNRef;

Default Value

Remarks

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


	Balance of cash benefit funds available on the EBT card.
	Balance of food stamp funds available on the EBT card.
	Contains the transaction Authorization code from the card issuer.
	The number of the current batch, in which this transaction is contained.
	Indicates the credit card type or payment method.
	Contains the transaction result code from the Global Transport Gateway.
	Contains the raw response from the Global Payments host.
	Action code (or sequence number) returned by Global Payments.
	Merchant Id code which must be printed on all receipts.
	Contains a human-readable response message concerning the processed transaction.
	Contains an additional, more detailed message about the results of the transaction.
	Uniquely identifies the transaction in the Global Transport Gateway.

Server Property (GlobalBenefit 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.

SSLAcceptServerCertEncoded Property (GlobalBenefit Module)

This is the certificate (PEM/base64 encoded).

Syntax

Swift
Objective-C

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

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}


@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

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

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (GlobalBenefit Module)

This is the certificate (PEM/base64 encoded).

Syntax

Swift
Objective-C

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

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}


@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 is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (GlobalBenefit Module)

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

Syntax

Swift
Objective-C

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

public var sslCertStoreB: Data {
  get {...}
  set {...}
}


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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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


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

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

SSLCertStorePassword Property (GlobalBenefit Module)

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

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

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

Default Value

Remarks

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

SSLCertStoreType Property (GlobalBenefit Module)

This is the type of certificate store for this certificate.

Syntax

Swift
Objective-C

public var sslCertStoreType: GlobalbenefitSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum GlobalbenefitSSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}


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

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

Default Value

Remarks

This is the type of certificate store for this certificate.

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 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 PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SSLCertSubject Property (GlobalBenefit Module)

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

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

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

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

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

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

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

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

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


Field	Meaning
CN	Common Name. This is commonly a host name 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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (GlobalBenefit Module)

This specifies the SSL/TLS implementation to use.

Syntax

Swift
Objective-C

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

public enum GlobalbenefitSSLProviders: 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:


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.

SSLServerCertEncoded Property (GlobalBenefit Module)

This is the certificate (PEM/base64 encoded).

Syntax

Swift
Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}


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

- (NSString*)SSLServerCertEncoded;

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

- (NSData*)SSLServerCertEncodedB;

Default Value

Remarks

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

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

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

Timeout Property (GlobalBenefit Module)

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

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TransactionAmount Property (GlobalBenefit Module)

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

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=transactionAmount,setter=setTransactionAmount:) NSString* transactionAmount;

- (NSString*)transactionAmount;
- (void)setTransactionAmount :(NSString*)newTransactionAmount;

Default Value

Remarks

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

Note that the TransactionAmount should include any GratuityAmount and/or TaxAmount. For example, if the sale price of the transaction is $10.00, and the tip on the transaction is $3.00 (for a grand total of $13.00), the TransactionAmount property should contain "13.00" and the GratuityAmount property should contain "3.00".

UserId Property (GlobalBenefit 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.

BalanceInquiry Method (GlobalBenefit Module)

Retrieves the current balances of Food Stamp and Cash Benefit accounts on an EBT card.

Syntax

Swift
Objective-C

public func balanceInquiry() throws -> Void

- (void)balanceInquiry;

Remarks

A BalanceInquiry transaction requests that Global Payments return the amount of funds remaining on the customer's EBT Card. No charge is made to the customer's card. The balance results from a balance inquiry on a Food Stamps card will be returned in ResponseFoodStampBalance, and the balance results from an inquiry on a Cash Benefits card will be returned in ResponseCashBenefitsBalance. For a card that accesses both Food Stamp and Cash Benefit accounts, both balances may be returned.

Config Method (GlobalBenefit 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.

Interrupt Method (GlobalBenefit Module)

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

Refund Method (GlobalBenefit Module)

Submits a food stamp credit transaction, returning funds to an EBT card.

Syntax

Swift
Objective-C

public func refund(pnRef: String) throws -> Void

- (void)refund:(NSString*)PNRef;

Remarks

EBT credit (return) transactions are similar to debit credits in that they are real-time -- Funds are immediately added back to the customer's food stamp account, instead of the funds transfer taking place several days after settlement. EBT credits may use track2 data read from the card's magnetic stripe, or be manually keyed. Track1 data is not acceptable. The customer is required to enter enter their PIN into a certified PIN Pad device, and both an EncryptedPIN and KSN are returned from the pad to the merchant, and must be submitted in the Credit/Refund transaction.

Note that credits are only supported for the food stamp BenefitType. Attempting to send a Refund when the BenefitType is set to Cash Benefits will result in an error.

This transaction is automatically added to the current open batch, and will be settled after the current batch is released with the GlobalBatchMgr class.

Reset Method (GlobalBenefit 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.

Sale Method (GlobalBenefit Module)

Submits a sale transaction for an Electronic Benefits (EBT) card.

Syntax

Swift
Objective-C

public func sale() throws -> Void

- (void)sale;

Remarks

EBT sale transactions are similar to Debit card transactions in that they are real-time and require an EncryptedPIN and KSN. EBT cards are connected to either a Food Stamp account or a Cash Benefit account, or both. Like debit transactions, EBT transactions also must use track2 data read from the card's magnetic stripe - track1 data is not acceptable. Food stamp transactions MAY be manually keyed, but cash benefit transactions may NOT be manually keyed. The BenefitType property indicates whether the sale acts on a Food Stamp or Cash Benefit account.

This transaction is automatically added to the current open batch, and will be settled after the current batch is released with the GlobalBatchMgr class.

The EBT card may be specified by either a CardMagneticStripe returned by a card reader, (Track2 only), or manually entered through the CardNumber. CardExpMonth, and CardExpYear.

The ResponseCode and ResponseText properties indicate whether this transaction was successful. For example:

Swiped Cash Benefits transaction with cash back: class.CardEntryDataSource = edsMagneticStripe class.CardMagneticStripe = "9999999800002773=09121015432112345678" class.EncryptedPIN = "623F36B53CC18393" class.KSN = "000000008F000021" class.BenefitType = btCashBenefits class.TransactionAmount = "25.00" '$20 purchase with $5 cash back class.CashBack = "5.00" class.Sale

Manually-keyed Food Stamp transaction: class.CardEntryDataSource = edsManuallyEntered class.CardNumber = "9999999800002773" class.CardExpYear = 12 class.CardExpMonth = 2015 class.EncryptedPIN = "623F36B53CC18393" class.KSN = "000000008F000021" class.BenefitType = btFoodStamps class.TransactionAmount = "25.00" 'Cash back not supported for food stamps! class.Sale

VoucherSale Method (GlobalBenefit Module)

Used to clear (force) a food stamp voucher that was previously voice-authorized.

Syntax

Swift
Objective-C

public func voucherSale(authCode: String, voucherNumber: String) throws -> Void

- (void)voucherSale:(NSString*)authCode :(NSString*)voucherNumber;

Remarks

If any aspect of the EBT system is down, the merchant may call the issuing state's processor for a voice authorization for Food Stamp transactions only. The merchant must complete a Manual Voucher form (provided by Global Payments or state EBT contractor) to obtain the authorization number, the voucher number and the client's signature. This puts a hold on the funds in the client's account for the amount of the voice authorization. To receive payment for the transaction, the merchant must process a Voucher Clear transaction within ten days of the voice authorization. To send a voucher clear/voucher sale, just call this method with the AuthCode and VoucherNumber parameters set.

Note that only food stamp transactions may be voice-authorized, attempting to call this method when the BenefitType is set to Cash Benefits will result in an error.

Error Event (GlobalBenefit Module)

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

ErrorCode contains an error code and Description 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 (GlobalBenefit 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

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Syntax

Swift
Objective-C

func onSSLStatus(message: String)

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

Remarks

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

Status Event (GlobalBenefit 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.

CCCard Type

Contains the customer's credit card information.

Remarks

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

Example: Setting the Fields CCCard card = new CCCard(); card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A"; card.EntryDataSource = edsTrack1; Example: Using a Constructor CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);

If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the , , and fields, and must be set to one of the manually entered enumerations.

Example: Setting the Fields CCCard card = new CCCard(); card.Number = "4788250000028291"; card.ExpMonth = 12; card.ExpYear = 2010; card.EntryDataSource = edsManualEntryNoCardReader; Example: Using a Constructor CCCard card = new CCCard("4012000033330026", 04, 2009); Note that the constructor in the previous example automatically sets the to edsManualEntryNoCardReader. If you wish to set any other value for the , you must set it yourself before authorizing the transaction.

When authorizing a transaction, the fields used by the class are solely dependant on the value of . If you set the , , and fields, but is set to edsTrack2, the class will look for data when authorizing the transaction, and will because none is present.

Fields

cardType
TCardTypes
Default Value: 0

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the is set, but it can also be changed manually. A list of valid card types is included below.


ctUnknown (0)	Invalid or unknown prefix, card type not known.
ctVisa (1)	Visa or Delta Card.
ctMasterCard (2)	MasterCard.
ctAMEX (3)	American Express Card.
ctDiscover (4)	Discover Card.
ctDiners (5)	Diners Club or Carte Blanche Card.
ctJCB (6)	JCB Card.
ctVisaElectron (7)	Visa Electron Card (runs as a Visa for most gateways)
ctMaestro (8)	Maestro Card
ctLaser (10)	Laser Card (Ireland)

cvvData
String
Default Value: ""

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

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, will be automatically set to cvpProvided. If set to empty string (""), will be automatically set to cvpNotProvided.

cvvPresence
CCCVVPresences
Default Value: 0

Indicates the presence of the card verification value.

This property is used to indicate the presence of .

The class will automatically set this value to cvpProvided when a value is specified. You can explicitly specify the indicator by setting this property.

Available values are:

cvpNotProvided (0)
cvpProvided (1)
cvpIllegible (2)
cvpNotOnCard (3)

entryDataSource
EntryDataSources
Default Value: 0

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


edsTrack1 (0)	Full Magnetic stripe read and transmit, Track 1.
edsTrack2 (1)	Full magnetic stripe read and transmit, Track 2.
edsManualEntryTrack1Capable (2)	Manually keyed, Track 1 capable.
edsManualEntryTrack2Capable (3)	Manually keyed, Track 2 capable.
edsManualEntryNoCardReader (4)	Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions).
edsTrack1Contactless (5)	Full magnetic stripe read (Track 1 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsTrack2Contactless (6)	Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsManualEntryContactlessCapable (7)	Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only).
edsIVR (8)	Interactive Voice Response processing. This is applicable to Mail Order/Telephone Order (MOTO) transactions. (, , and are sent).
edsKiosk (9)	Automated kiosk transaction. Track1 or Track2 data must be sent in , the transaction cannot be manually entered.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.


TSYSHCBenefit	edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable
TSYSHCECommerce	edsManualEntryNoCardReader
TSYSHCRetail	edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

expMonth
Int32
Default Value: 1

Expiration month of the credit card specified in .

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

expYear
Int32
Default Value: 2000

Expiration year of the credit card specified in .

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

isEncrypted
Bool
Default Value: False

Determines whether data set to the or fields is validated.

By default, when the or fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and data will be parsed for the track specified by . However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the or fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the may be affected, and the card number will not be verified.

magneticStripe
String
Default Value: ""

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

If is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the property to indicate which track you are sending.

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

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

number
String
Default Value: ""

Customer's credit card number for the transaction.

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

Constructors

public init()

public init(number: , expMonth: , expYear: )

public init(magneticStripe: , entryDataSource: )

GlobalBenefitResponse Type

Contains the response to an electronic benefits (EBT) transaction.

Remarks

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

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.

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

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

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

Indicates the card type or payment method.

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

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

Balance of cash benefit funds available on the EBT card. This is the current available balance, less any holds due to pending authorizations or withdrawals, plus any credits or deposits, which are part of the day's activity. If present, this value must be printed on the customer's receipt.

Note that EBT cards may be linked to both a Food Stamp account and a Cash Benefit account, and the balance results for these are returned in the corresponding and properties.

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.

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

Contains the raw response data from the Global Payments host.

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

Balance of food stamp funds available on the EBT card. This is the current available balance, less any holds due to pending authorizations or withdrawals, plus any credits or deposits, which are part of the day's activity. If present, this value must be printed on the customer's receipt.

Note that EBT cards may be linked to both a Food Stamp account and a Cash Benefit account, and the balance results for these are returned in the corresponding and properties.

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

Action code returned by Global Payments.

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


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

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

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

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

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

Merchant Id code which must be printed on all receipts.

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

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 .

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

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

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

Constructors

public init()

Proxy Type

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

Fields

authScheme
ProxyAuthSchemes
Default Value: 0

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the 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 component 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

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

password
String
Default Value: ""

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

If is set to Basic Authentication, the and 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

This property contains 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

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


psAutomatic (0)	Default setting. If the URL is an `https` URL, the class will use the `psTunnel` option. If the URL is an `http` URL, the class will use the `psNever` option.
psAlways (1)	The connection is always SSL enabled.
psNever (2)	The connection is not SSL enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

user
String
Default Value: ""

This property contains a user name, if authentication is to be used for the proxy.

If is set to Basic Authentication, the and 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 (GlobalBenefit 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.

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

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.

The appropriate 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

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

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

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

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

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

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

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

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

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

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

MaxTransferRate: The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.nsoftware.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

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

By default, this config is set to false.

UseIPv6: Whether to use IPv6.

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


0	IPv4 Only
1	IPv6 Only
2	IPv6 with IPv4 fallback

SSL Config Settings

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

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

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

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

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

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

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

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

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

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

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the class is the same.

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

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

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

This setting specifies whether the class will check the Certificate Revocation List 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 will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

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

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

This 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 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 will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

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

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

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

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

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

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

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

The enabled cipher suites to be used in SSL negotiation.

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

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

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

Example values when SSLProvider is set to Internal:

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

Possible values when SSLProvider is set to Internal include:

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

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

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

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


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

SSLEnabledProtocols - TLS 1.3 Notes

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

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

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

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

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

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

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

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

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

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

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

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

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

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

SSLNegotiatedCipher: Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

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

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

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

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

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

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

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

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

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

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

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

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

SSLNegotiatedVersion: Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

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

SSLSecurityFlags: Flags that control certificate verification.

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


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

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

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

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

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

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

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

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class .

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

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

TLS12SupportedGroups: The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

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

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

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

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

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

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

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

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

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

Socket Config Settings

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

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

Note: This option is not valid for UDP ports.

FirewallData: Used to send extra data to the firewall.

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

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

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

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

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

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

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

Base Config Settings

BuildInfo: Information about the product's build.

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

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

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

The following is a list of valid code page identifiers:


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.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to 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: Tells the class 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 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 (GlobalBenefit Module)

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

HTTP Errors


	118 Firewall Error. Error description contains detailed message.
	143 Busy executing current method.
	151 HTTP protocol error. The error message has the server response.
	152 No server specified in URL
	153 Specified URLScheme is invalid.
	155 Range operation is not supported by server.
	156 Invalid cookie index (out of range).
	301 Interrupted.
	302 Can't open AttachedFile.

TCPClient Errors


	100 You cannot change the RemotePort at this time. A connection is in progress.
	101 You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102 The RemoteHost address is invalid (0.0.0.0).
	104 Already connected. If you want to reconnect, close the current connection first.
	106 You cannot change the LocalPort at this time. A connection is in progress.
	107 You cannot change the LocalHost at this time. A connection is in progress.
	112 You cannot change MaxLineLength at this time. A connection is in progress.
	116 RemotePort cannot be zero. Please specify a valid service port number.
	117 You cannot change the UseConnection option while the class is active.
	135 Operation would block.
	201 Timeout.
	211 Action impossible in control's present state.
	212 Action impossible while not connected.
	213 Action impossible while listening.
	301 Timeout.
	302 Could not open file.
	434 Unable to convert string to selected CodePage.
	1105 Already connecting. If you want to reconnect, close the current connection first.
	1117 You need to connect first.
	1119 You cannot change the LocalHost at this time. A connection is in progress.
	1120 Connection dropped by remote host.

SSL Errors


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

TCP/IP Errors


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