GlobalCharge Class

Properties   Methods   Events   Config Settings   Errors  

The GlobalCharge class is used to authorize credit card transactions with the Global Payments system, using the Global Transport Direct API. This class supports Direct Marketing, e-Commerce, Retail, and Restaurant environments, and allows for simple, direct, secure communication to the Global Transport TLS/SSL gateway through a standard Internet connection. This class can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

Class Name

DPaymentsSDK_GlobalCharge

Procedural Interface

 dpaymentssdk_globalcharge_open();
 dpaymentssdk_globalcharge_close($res);
 dpaymentssdk_globalcharge_register_callback($res, $id, $function);
 dpaymentssdk_globalcharge_get_last_error($res);
 dpaymentssdk_globalcharge_get_last_error_code($res);
 dpaymentssdk_globalcharge_set($res, $id, $index, $value);
 dpaymentssdk_globalcharge_get($res, $id, $index);
 dpaymentssdk_globalcharge_do_authonly($res);
 dpaymentssdk_globalcharge_do_avsonly($res);
 dpaymentssdk_globalcharge_do_balanceinquiry($res);
 dpaymentssdk_globalcharge_do_capture($res, $pnref);
 dpaymentssdk_globalcharge_do_config($res, $configurationstring);
 dpaymentssdk_globalcharge_do_credit($res);
 dpaymentssdk_globalcharge_do_force($res, $approvalcode);
 dpaymentssdk_globalcharge_do_interrupt($res);
 dpaymentssdk_globalcharge_do_refund($res, $pnref);
 dpaymentssdk_globalcharge_do_repeatsale($res, $pnref);
 dpaymentssdk_globalcharge_do_reset($res);
 dpaymentssdk_globalcharge_do_reverse($res, $pnref);
 dpaymentssdk_globalcharge_do_sale($res);
 dpaymentssdk_globalcharge_do_tipadjustment($res, $pnref, $gratuityamount);
 dpaymentssdk_globalcharge_do_voidtransaction($res, $pnref);

Remarks

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

After the merchant information is setup, you may enter transaction data. When the credit card's CardEntryDataSource is Manually Entered, the merchant should fill the CardNumber, CardExpMonth, and CardExpYear properties. Address Verification Service (AVS) data may be sent by filling the CustomerAddress and CustomerZip properties. For swiped transactions (Retail and Restaurant industries) the CardEntryDataSource should be set to edsMagneticStripe and, the CardMagneticStripe property should be filled with the trackdata read from the card. In addition, the TransactionAmount should be set with the total amount for the transaction.

Now simply call the Sale or AuthOnly method to send the authorization to the Global Transport Server.

The status of the authorization request will be stored in the ResponseCode property, with human-readable text appearing in the ResponseText property. There are several other Response properties which will contain data that should be logged.

You may also use this class to Capture previously made AuthOnly transactions, void (VoidTransaction), Refund, and Reverse transactions, and validate address data without charging the card using AVSOnly.

Once a transaction request is approved, the transaction is added to the current batch on the Global Transport Server, and the money in the customer's account is blocked and tagged for the merchant. The transaction must go through Settlement in order for the blocked money to be transferred to the merchant's account.

If your Global Transport account is setup with the Host Auto Settle feature, you need take no further action. The Global Transport system will close the current open batch at a designated time each day. This means that there is no end of day batch processing required from the merchant.

If your account is not set up to automatically settle transactions at the end of the day, then at the end of the day you will need to use the GlobalBatchMgr class to capture the transactions in the batch.

Property List


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

CardTypeType of credit card being used in this transaction.
CardCVVDataThree digit security code on back of card (optional).
CardCVVPresenceIndicates the presence of the card verification value.
CardEntryDataSourceThis property contains a 1-character code identifying the source of the customer data.
CardExpMonthExpiration month of the credit card specified in Number .
CardExpYearExpiration year of the credit card specified in Number .
CardIsEncryptedDetermines whether data set to the Number or MagneticStripe properties is validated.
CardMagneticStripeTrack data read off of the card's magnetic stripe.
CardNumberCustomer's credit card number for the transaction.
CustomerAddressCardholder's billing street address, which is used for address verification.
CustomerIdContains a merchant-assigned number to identify the customer.
CustomerNameThe cardholder's name as it appears on the card.
CustomerZipThe Cardholder's billing postal code, which is used in address verification.
GratuityAmountTip portion of the TransactionAmount .
InvoiceNumberOptional invoice tracking number.
PasswordPassword for authentication with the Global Payments Server .
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a username if authentication is to be used for the proxy.
PurchaseOrderNumRequired for the lowest rate on Commercial/Purchasing card (Level 2) transactions.
RegisterNumberA number that uniquely identifies the register or computer on which the transaction was performed.
ResponseApprovalCodeContains the transaction authorization code from the card issuer.
ResponseAuthorizedAmountIn the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.
ResponseAVSResultCodeContains the address verification result code from the card issuer.
ResponseAVSResultMessageContains a formatted and human-readable response message describing the AVSResultCode .
ResponseBalanceAvailable balance remaining on a pre-paid credit card.
ResponseBalanceDueIn the case of a partial authorization, indicates the amount the customer still owes the merchant.
ResponseBatchNumberThe number of the batch this transaction is currently contained in.
ResponseCardTypeIndicates the card type or payment method.
ResponseCodeContains the transaction result code from the Global Transport Gateway.
ResponseCommercialCardIndicates if the card that was just authorized was a commercial card.
ResponseCVVResultCodeContains the card verification result code from the card issuer.
ResponseCVVResultMessageContains a formatted and human-readable response message describing the CVVResultCode .
ResponseDataContains the raw response data from the Global Payments host.
ResponseHostCodeAction code returned by Global Payments.
ResponseInvoiceNumberContains the same invoice number for the transaction that was originally sent in the request to the Global Transport Gateway.
ResponseMerchantCodeMerchant Id code which must be printed on all receipts.
ResponseMessageContains a human-readable response message concerning the processed transaction.
ResponseMessageDetailContains a formatted response message concerning the processed transaction.
ResponsePNRefContains a number which uniquely identifies the transaction in the Global Transport system.
ResponseTransactionIdCard issuer's Transaction Reference Number.
ResponseValidationCodeVisa Validation code.
ServerGlobal Payments transaction server.
ServerIdUnique server identification number.
SSLAcceptServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/Base64 encoded).
TaxAmountRequired for the lowest rate on Commercial/Purchasing card (Level 2) transactions.
TimeoutA timeout for the class.
TransactionAmountAmount to be charged from (or refunded to) the card.
UserIdUserId for authentication with the Global Payments Server .

Method List


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

AuthOnlySends an AuthOnly transaction to the host.
AVSOnlyPerforms AVS and CVV card validation checks without actually making a transaction.
BalanceInquiryA Credit Card Balance Inquiry transaction displays the remaining balance on a pre-paid credit card.
CaptureSends a capture transaction to the Global Payments Server.
ConfigSets or retrieves a configuration setting.
CreditCredits a cardholder's account.
ForceSends a Voice Authorization (Force) transaction to the Global Payments Server.
InterruptInterrupt the current method.
RefundRefunds a previous transaction.
RepeatSaleUsed to submit a recurring transaction.
ResetClears all properties to their default values.
ReverseReverses a transaction in the current batch.
SaleSends a Sale transaction to the host.
TipAdjustmentThis methods adds a tip to the original sale transaction.
VoidTransactionVoids a transaction in the current batch.

Event List


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

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

Config Settings


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

CardPresentOverrides merchant settings to perform a card present or card not present transaction.
CardVerifyWhether the transaction type is CardVerify.
ContactOnlyIndicates if the POS device is only able to accept chip inserted EMV transactions.
DuplicateCheckingEnables or disables duplicate transaction checking.
EMVCapableIndicates whether the Point of Sale is EMV enabled.
EMVDataThe EMV data returned from a Pin Pad after reading an EMV card.
EMVEntryDataSourceThe EMV Data Entry Source (DES).
EMVOnlineKSNClear-text Key Sequence Number for EMV Online PIN transactions.
EMVOnlinePINDUKPT DES encrypted PIN block for EMV Online PIN transactions.
PINCapableIndicates if the POS device is capable of accepting PINs.
PNRefUniquely identifies the transaction in the Global Transport Gateway.
RawRequestReturns the request sent to the server for debugging purposes.
RawResponseReturns the response received from the server for debugging purposes.
ResponseEMVDataThe response EMV data.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

CardType Property (DPaymentsSDK_GlobalCharge Class)

Type of credit card being used in this transaction.

Object Oriented Interface


public function getCardType();


public function setCardType($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 1 );


dpaymentssdk_globalcharge_set($res, 1, $value );

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber 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)

This property is not available at design time.

Data Type

Integer

CardCVVData Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getCardCVVData();


public function setCardCVVData($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 2 );


dpaymentssdk_globalcharge_set($res, 2, $value );

Default Value

''

Remarks

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 CardCVVData 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, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (DPaymentsSDK_GlobalCharge Class)

Indicates the presence of the card verification value.

Object Oriented Interface


public function getCardCVVPresence();


public function setCardCVVPresence($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 3 );


dpaymentssdk_globalcharge_set($res, 3, $value );

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

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

Available values are:

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

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (DPaymentsSDK_GlobalCharge Class)

This property contains a 1-character code identifying the source of the customer data.

Object Oriented Interface


public function getCardEntryDataSource();


public function setCardEntryDataSource($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 4 );


dpaymentssdk_globalcharge_set($res, 4, $value );

Default Value

0

Remarks

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. (CardNumber, CardExpMonth, and CardExpYear are sent).
edsKiosk (9)Automated kiosk transaction. Track1 or Track2 data must be sent in CardMagneticStripe, 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

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (DPaymentsSDK_GlobalCharge Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface


public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 5 );


dpaymentssdk_globalcharge_set($res, 5, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardExpYear Property (DPaymentsSDK_GlobalCharge Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface


public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 6 );


dpaymentssdk_globalcharge_set($res, 6, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

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.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (DPaymentsSDK_GlobalCharge Class)

Determines whether data set to the Number or MagneticStripe properties is validated.

Object Oriented Interface


public function getCardIsEncrypted();


public function setCardIsEncrypted($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 7 );


dpaymentssdk_globalcharge_set($res, 7, $value );

Default Value

false

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. 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 CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 8 );


dpaymentssdk_globalcharge_set($res, 8, $value );

Default Value

''

Remarks

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

If CardEntryDataSource 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 CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource 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.

This property is not available at design time.

Data Type

String

CardNumber Property (DPaymentsSDK_GlobalCharge Class)

Customer's credit card number for the transaction.

Object Oriented Interface


public function getCardNumber();


public function setCardNumber($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 9 );


dpaymentssdk_globalcharge_set($res, 9, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

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

This property is not available at design time.

Data Type

String

CustomerAddress Property (DPaymentsSDK_GlobalCharge Class)

Cardholder's billing street address, which is used for address verification.

Object Oriented Interface


public function getCustomerAddress();


public function setCustomerAddress($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 10 );


dpaymentssdk_globalcharge_set($res, 10, $value );

Default Value

''

Remarks

This property is optional, but is required for the lowest rate on keyed transactions. This may contain up to 20 alphanumeric characters, but only the numeric portion of the street address is actually necessary for AVS checking.

Data Type

String

CustomerId Property (DPaymentsSDK_GlobalCharge Class)

Contains a merchant-assigned number to identify the customer.

Object Oriented Interface


public function getCustomerId();


public function setCustomerId($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 11 );


dpaymentssdk_globalcharge_set($res, 11, $value );

Default Value

''

Remarks

This property may contain a unique number that identifies a specific customer. The merchant defines and assigns this number to their customer. It may be up to 24 alphanumeric characters in length.

Data Type

String

CustomerName Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getCustomerName();


public function setCustomerName($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 12 );


dpaymentssdk_globalcharge_set($res, 12, $value );

Default Value

''

Remarks

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

Data Type

String

CustomerZip Property (DPaymentsSDK_GlobalCharge Class)

The Cardholder's billing postal code, which is used in address verification.

Object Oriented Interface


public function getCustomerZip();


public function setCustomerZip($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 13 );


dpaymentssdk_globalcharge_set($res, 13, $value );

Default Value

''

Remarks

This property is optional, but is required for the lowest rate on keyed transactions. This may contain up to 9 alphanumeric characters. Note that the supported Canadian postal code formats are "LNL NLN" and "LNLNLN".

Data Type

String

GratuityAmount Property (DPaymentsSDK_GlobalCharge Class)

Tip portion of the TransactionAmount .

Object Oriented Interface


public function getGratuityAmount();


public function setGratuityAmount($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 14 );


dpaymentssdk_globalcharge_set($res, 14, $value );

Default Value

''

Remarks

This property is only applicable to Restaurant (table service) transactions. It may contain up to 8 characters in the format "DDDDD.CC", left-justified with no fill. (eg "1.99").

Note that the TransactionAmount should always include any GratuityAmount. 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".

Data Type

String

InvoiceNumber Property (DPaymentsSDK_GlobalCharge Class)

Optional invoice tracking number.

Object Oriented Interface


public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 15 );


dpaymentssdk_globalcharge_set($res, 15, $value );

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.

Data Type

String

Password Property (DPaymentsSDK_GlobalCharge Class)

Password for authentication with the Global Payments Server .

Object Oriented Interface


public function getPassword();


public function setPassword($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 16 );


dpaymentssdk_globalcharge_set($res, 16, $value );

Default Value

''

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 17 );


dpaymentssdk_globalcharge_set($res, 17, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 18 );


dpaymentssdk_globalcharge_set($res, 18, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 19 );


dpaymentssdk_globalcharge_set($res, 19, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getProxyPort();


public function setProxyPort($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 20 );


dpaymentssdk_globalcharge_set($res, 20, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getProxyServer();


public function setProxyServer($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 21 );


dpaymentssdk_globalcharge_set($res, 21, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getProxySSL();


public function setProxySSL($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 22 );


dpaymentssdk_globalcharge_set($res, 22, $value );

Default Value

0

Remarks

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

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

Data Type

Integer

ProxyUser Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getProxyUser();


public function setProxyUser($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 23 );


dpaymentssdk_globalcharge_set($res, 23, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

PurchaseOrderNum Property (DPaymentsSDK_GlobalCharge Class)

Required for the lowest rate on Commercial/Purchasing card (Level 2) transactions.

Object Oriented Interface


public function getPurchaseOrderNum();


public function setPurchaseOrderNum($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 24 );


dpaymentssdk_globalcharge_set($res, 24, $value );

Default Value

''

Remarks

This property may contain a Purchase Order Number from the customer. It may be up to 17 alphanumeric characters in length.

Data Type

String

RegisterNumber Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getRegisterNumber();


public function setRegisterNumber($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 25 );


dpaymentssdk_globalcharge_set($res, 25, $value );

Default Value

''

Remarks

This may be up to 10 alphanumeric characters in length.

Data Type

String

ResponseApprovalCode Property (DPaymentsSDK_GlobalCharge Class)

Contains the transaction authorization code from the card issuer.

Object Oriented Interface


public function getResponseApprovalCode();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 26 );


Default Value

''

Remarks

Contains the transaction authorization code from the card issuer.

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

This property is read-only.

Data Type

String

ResponseAuthorizedAmount Property (DPaymentsSDK_GlobalCharge Class)

In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.

Object Oriented Interface


public function getResponseAuthorizedAmount();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 27 );


Default Value

''

Remarks

In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.

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 ResponseCode will contain "200", the ResponseMessage will contain "Partial Approval", and the ResponseMessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the ResponseAuthorizedAmount will contain the amount of the transaction that was authorized, and the ResponseBalanceDue property will indicate the amount still owed by the customer.

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

This property is read-only.

Data Type

String

ResponseAVSResultCode Property (DPaymentsSDK_GlobalCharge Class)

Contains the address verification result code from the card issuer.

Object Oriented Interface


public function getResponseAVSResultCode();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 28 );


Default Value

''

Remarks

Contains the address verification result code from the card issuer.

When programmatically validating an AVS Result, this value should ALWAYS be used instead of any formatted ResponseAVSResultMessage describing the result. The following table lists the possible AVS result codes:

X Exact: Address and nine-digit Zip match.
Y Yes: Address and five-digit Zip match.
A Address: Address matches, Zip does not.
Z 5-digit Zip: 5-digit Zip matches, address doesn't.
W Whole Zip: 9-digit Zip matches, address doesn't.
N No: Neither address nor Zip matches.
U Unavailable: Address information not available.
G Unavailable: Address information not available for international transaction.
R Retry: System unavailable or time-out.
E Error: Transaction unintelligible for AVS or edit error found in the message that prevents AVS from being performed.
S Not Supported: Issuer doesn't support AVS service.
B * Street Match: Street addresses match for international transaction, but postal code doesn't.
C * Street Address: Street addresses and postal code not verified for international transaction.
D * Match: Street addresses and postal codes match for international transaction.
I * Not Verified: Address Information not verified for International transaction.
M * Match: Street addresses and postal codes match for international transaction.
P * Postal Match: Postal codes match for international transaction, but street address doesn't.
0 ** No response sent.
5 Invalid AVS response.

* These values are Visa specific.

** These values are returned by the Global Transport Gateway and not the issuing bank.

This property is read-only.

Data Type

String

ResponseAVSResultMessage Property (DPaymentsSDK_GlobalCharge Class)

Contains a formatted and human-readable response message describing the AVSResultCode .

Object Oriented Interface


public function getResponseAVSResultMessage();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 29 );


Default Value

''

Remarks

Contains a formatted and human-readable response message describing the ResponseAVSResultCode.

Do NOT use this when programmatically validating a transaction's AVS result; Use the ResponseAVSResultCode property instead.

This property is read-only.

Data Type

String

ResponseBalance Property (DPaymentsSDK_GlobalCharge Class)

Available balance remaining on a pre-paid credit card.

Object Oriented Interface


public function getResponseBalance();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 30 );


Default Value

''

Remarks

Available balance remaining on a pre-paid credit card.

If this value is returned in the transaction response, print the value on the receipt. If the card in question is not a pre-paid credit card, this property will contain the text "BALANCE NOT AVAILABLE".

This property is read-only.

Data Type

String

ResponseBalanceDue Property (DPaymentsSDK_GlobalCharge Class)

In the case of a partial authorization, indicates the amount the customer still owes the merchant.

Object Oriented Interface


public function getResponseBalanceDue();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 31 );


Default Value

''

Remarks

In the case of a partial authorization, indicates the amount the customer still owes the merchant.

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 ResponseCode will contain "200", the ResponseMessage will contain "Partial Approval", and the ResponseMessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the ResponseAuthorizedAmount will contain the amount of the transaction that was authorized, and the ResponseBalanceDue property will indicate the amount still owed by the customer.

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

This property is read-only.

Data Type

String

ResponseBatchNumber Property (DPaymentsSDK_GlobalCharge Class)

The number of the batch this transaction is currently contained in.

Object Oriented Interface


public function getResponseBatchNumber();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 32 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ResponseCardType Property (DPaymentsSDK_GlobalCharge Class)

Indicates the card type or payment method.

Object Oriented Interface


public function getResponseCardType();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 33 );


Default Value

''

Remarks

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

This property is read-only.

Data Type

String

ResponseCode Property (DPaymentsSDK_GlobalCharge Class)

Contains the transaction result code from the Global Transport Gateway.

Object Oriented Interface


public function getResponseCode();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 34 );


Default Value

''

Remarks

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

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

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

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

This property is read-only.

Data Type

String

ResponseCommercialCard Property (DPaymentsSDK_GlobalCharge Class)

Indicates if the card that was just authorized was a commercial card.

Object Oriented Interface


public function getResponseCommercialCard();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 35 );


Default Value

false

Remarks

Indicates if the card that was just authorized was a commercial card.

This value is only applicable to credit card transactions.

This property is read-only.

Data Type

Boolean

ResponseCVVResultCode Property (DPaymentsSDK_GlobalCharge Class)

Contains the card verification result code from the card issuer.

Object Oriented Interface


public function getResponseCVVResultCode();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 36 );


Default Value

''

Remarks

Contains the card verification result code from the card issuer.

This value is only applicable to credit card transactions. The card verification number is typically printed on the back of the card and not embossed on the front. It is used as an extra authentication method for "card not present" transactions. When programmatically validating a CV Result, this value should ALWAYS be used instead of any formatted response message describing the result, contained in the ResponseCVVResultMessage property.

The following table lists the possible result codes for this property:

Value Description
M CVV2/CVC2/CID Match
N CVV2/CVC2/CID No Match
P Not Processed
S Issuer indicates that the CV data should be present on the card, but the merchant has indicated that the CV data is not present on the card.
U Unknown / Issuer has not certified for CV or issuer has not provided Visa/MasterCard with the
CV encryption keys.
X Server Provider did not respond

This property is read-only.

Data Type

String

ResponseCVVResultMessage Property (DPaymentsSDK_GlobalCharge Class)

Contains a formatted and human-readable response message describing the CVVResultCode .

Object Oriented Interface


public function getResponseCVVResultMessage();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 37 );


Default Value

''

Remarks

Contains a formatted and human-readable response message describing the ResponseCVVResultCode.

This value is only applicable to credit card transactions. Do NOT use this when programmatically validating a transaction's CV result; Use the ResponseCVVResultCode property instead.

This property is read-only.

Data Type

String

ResponseData Property (DPaymentsSDK_GlobalCharge Class)

Contains the raw response data from the Global Payments host.

Object Oriented Interface


public function getResponseData();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 38 );


Default Value

''

Remarks

Contains the raw response data from the Global Payments host.

This property is read-only.

Data Type

String

ResponseHostCode Property (DPaymentsSDK_GlobalCharge Class)

Action code returned by Global Payments.

Object Oriented Interface


public function getResponseHostCode();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 39 );


Default Value

''

Remarks

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 ResponseHostCode will indicate the reason for the decline. The table below lists the possible ResponseHostCode and ResponseMessage combinations for error conditions.

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

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

This property is read-only.

Data Type

String

ResponseInvoiceNumber Property (DPaymentsSDK_GlobalCharge Class)

Contains the same invoice number for the transaction that was originally sent in the request to the Global Transport Gateway.

Object Oriented Interface


public function getResponseInvoiceNumber();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 40 );


Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ResponseMerchantCode Property (DPaymentsSDK_GlobalCharge Class)

Merchant Id code which must be printed on all receipts.

Object Oriented Interface


public function getResponseMerchantCode();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 41 );


Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ResponseMessage Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getResponseMessage();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 42 );


Default Value

''

Remarks

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

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

This property is read-only.

Data Type

String

ResponseMessageDetail Property (DPaymentsSDK_GlobalCharge Class)

Contains a formatted response message concerning the processed transaction.

Object Oriented Interface


public function getResponseMessageDetail();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 43 );


Default Value

''

Remarks

Contains a formatted response message concerning the processed transaction. This property will contain an additional message about the results of the transaction, providing more detail than the ResponseMessage 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 ResponseCode property instead.

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

This property is read-only.

Data Type

String

ResponsePNRef Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getResponsePNRef();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 44 );


Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

ResponseTransactionId Property (DPaymentsSDK_GlobalCharge Class)

Card issuer's Transaction Reference Number.

Object Oriented Interface


public function getResponseTransactionId();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 45 );


Default Value

''

Remarks

Card issuer's Transaction Reference Number.

This property contains a Visa Transaction Id, MasterCard BankNet Reference Number, American Express Transaction Id, or Discover STAN Id. If returned in the response, this property must be printed on the receipt. Note that this ResponseTransactionId is not used by Global Payments to reference the transaction. The ResponsePNRef property is used to track and modify transactions made on the Global Payments system.

This property is read-only.

Data Type

String

ResponseValidationCode Property (DPaymentsSDK_GlobalCharge Class)

Visa Validation code.

Object Oriented Interface


public function getResponseValidationCode();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 46 );


Default Value

''

Remarks

Visa Validation code.

If this value is returned in the transaction response it must be printed on the receipt. It will only be returned for the Visa ResponseCardType.

This property is read-only.

Data Type

String

Server Property (DPaymentsSDK_GlobalCharge Class)

Global Payments transaction server.

Object Oriented Interface


public function getServer();


public function setServer($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 47 );


dpaymentssdk_globalcharge_set($res, 47, $value );

Default Value

'https://api.globalpay.com'

Remarks

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

Data Type

String

ServerId Property (DPaymentsSDK_GlobalCharge Class)

Unique server identification number.

Object Oriented Interface


public function getServerId();


public function setServerId($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 48 );


dpaymentssdk_globalcharge_set($res, 48, $value );

Default Value

''

Remarks

This property is used to identify the unique server (waiter/waitress) making the transaction. This only applies to Restaurant (table service) transactions, and may be up to 4 alphanumeric characters in length.

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_GlobalCharge Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface


public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 50 );


dpaymentssdk_globalcharge_set($res, 50, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DPaymentsSDK_GlobalCharge Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 78 );


dpaymentssdk_globalcharge_set($res, 78, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 94 );


dpaymentssdk_globalcharge_set($res, 94, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 95 );


dpaymentssdk_globalcharge_set($res, 95, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (DPaymentsSDK_GlobalCharge Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 96 );


dpaymentssdk_globalcharge_set($res, 96, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

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

Note: This store type is not available in Java.

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

Note: This store type is not available in Java.

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

Note: This store type is only available in Java.

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

Note: this store type is only available in Java.

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

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

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

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

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

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

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

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

Data Type

Integer

SSLCertSubject Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 97 );


dpaymentssdk_globalcharge_set($res, 97, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DPaymentsSDK_GlobalCharge Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface


public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 105 );


dpaymentssdk_globalcharge_set($res, 105, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

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

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

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

Data Type

Integer

SSLServerCertEncoded Property (DPaymentsSDK_GlobalCharge Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface


public function getSSLServerCertEncoded();


Procedural Interface


dpaymentssdk_globalcharge_get($res, 107 );


Default Value

''

Remarks

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

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

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

Data Type

Binary String

TaxAmount Property (DPaymentsSDK_GlobalCharge Class)

Required for the lowest rate on Commercial/Purchasing card (Level 2) transactions.

Object Oriented Interface


public function getTaxAmount();


public function setTaxAmount($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 134 );


dpaymentssdk_globalcharge_set($res, 134, $value );

Default Value

''

Remarks

This property may be up to 9 characters, in the format "DDDDDD.CC", and be left-justified with no fill. (eg: "1.99"). Note that the TaxAmount should be included in the total TransactionAmount. For example, if the sale price of the transaction is $10.00, and the tax on the transaction is $0.60 (for a grand total of $10.60), the TransactionAmount property should contain "10.60" and the TaxAmount property should contain "0.60".

Data Type

String

Timeout Property (DPaymentsSDK_GlobalCharge Class)

A timeout for the class.

Object Oriented Interface


public function getTimeout();


public function setTimeout($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 135 );


dpaymentssdk_globalcharge_set($res, 135, $value );

Default Value

60

Remarks

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

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

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

If Timeout expires, and the operation is not yet complete, the class fails with an error.

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransactionAmount Property (DPaymentsSDK_GlobalCharge Class)

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

Object Oriented Interface


public function getTransactionAmount();


public function setTransactionAmount($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 136 );


dpaymentssdk_globalcharge_set($res, 136, $value );

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

Data Type

String

UserId Property (DPaymentsSDK_GlobalCharge Class)

UserId for authentication with the Global Payments Server .

Object Oriented Interface


public function getUserId();


public function setUserId($value);

Procedural Interface


dpaymentssdk_globalcharge_get($res, 137 );


dpaymentssdk_globalcharge_set($res, 137, $value );

Default Value

''

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

AuthOnly Method (DPaymentsSDK_GlobalCharge Class)

Sends an AuthOnly transaction to the host.

Object Oriented Interface

public function doAuthOnly();

Procedural Interface

dpaymentssdk_globalcharge_do_authonly($res);

Remarks

An Auth Only transaction is used to verify and reserve the cardholder's open-to-buy funds available at that time. This transaction is NOT added to the open batch. In order to settle (be paid) for this transaction, the merchant must run a Capture transaction using the original ResponsePNRef obtained during this Auth Only transaction. Only then will the transaction be added to the open batch. Typically any funds blocked with a Sale or Auth Only transaction are reserved for approximately seven (7) to ten (10) days. This may vary from issuer to issuer. Sample transactions follow.

AuthOnly transaction with Track 1 data: class.CardEntryDataSource = edsMagneticStripe class.CardMagneticStripe = "5499990123456781=15125025432198712345" class.TransactionAmount = "1.00" class.AuthOnly() Manually keyed AuthOnly transaction: class.CardEntryDataSource = edsManuallyEntered class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2010 class.TransactionAmount = "1.00" class.AuthOnly()

AVSOnly Method (DPaymentsSDK_GlobalCharge Class)

Performs AVS and CVV card validation checks without actually making a transaction.

Object Oriented Interface

public function doAVSOnly();

Procedural Interface

dpaymentssdk_globalcharge_do_avsonly($res);

Remarks

Please note that an AVSOnly transaction will not place a hold on any funds and will not reduce the cardholder's limit to buy. Also, an AVSOnly transaction will not place a transaction in the batch and no money will be transferred from the cardholder's account to the merchant's account. An AVS Only transaction should be used if the amount of the transaction is unknown but the merchant would like to perform validation that the card is good and the address matches what is on file at the issuer.

Once the amount of the transaction is known, process either a new Sale transaction, a RepeatSale using the PNRef returned in the AVS-Only Response, or a AuthOnly and then a Capture. Do not process a Force or Capture to "finalize" an AVSOnly transaction.

Note: The AVSOnly transaction is not supported in the eCommerce market.

BalanceInquiry Method (DPaymentsSDK_GlobalCharge Class)

A Credit Card Balance Inquiry transaction displays the remaining balance on a pre-paid credit card.

Object Oriented Interface

public function doBalanceInquiry();

Procedural Interface

dpaymentssdk_globalcharge_do_balanceinquiry($res);

Remarks

The only properties required for this transaction are the CardNumber, CardExpMonth, and CardExpYear, however you may submit the CustomerAddress and CustomerZip for Address Validation, and the CardCVVData property for CVV checking if so desired.

The balance of the prepaid card will be stored in ResponseBalance. If the card specified is not a pre-paid credit card, the ResponseBalance will either be empty or contain the text "BALANCE NOT AVAILABLE".

Capture Method (DPaymentsSDK_GlobalCharge Class)

Sends a capture transaction to the Global Payments Server.

Object Oriented Interface

public function doCapture($pnref);

Procedural Interface

dpaymentssdk_globalcharge_do_capture($res, $pnref);

Remarks

Capture (Post Auth Capture) transactions are typically used when a merchant has previously utilized the AuthOnly method. A Capture transaction adds the transaction to the current open batch. To process a capture, call Capture with the PNRef parameter set to the PNRef returned in response from the transaction for which you wish to capture and set the TransactionAmount to the amount you wish to capture. You may issue a partial capture for any value up to the original authorized amount. For example: Full Capture: class.TransactionAmount = "15.00"; // Original authorization was for $15.00, so this is a full capture class.Capture("1233513541"); // "1233513541" is the PNRef from the original transaction Partial Capture: class.TransactionAmount = "10.00"; // Original authorization was for $15.00, so this is a partial capture class.Capture("1233513541"); // PNRef from the original authorization response

Note: Only one Capture can be processed per AuthOnly. To process a second Capture on an AuthOnly you must first use VoidTransaction to Void the first Capture.

Config Method (DPaymentsSDK_GlobalCharge Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_globalcharge_do_config($res, $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.

Credit Method (DPaymentsSDK_GlobalCharge Class)

Credits a cardholder's account.

Object Oriented Interface

public function doCredit();

Procedural Interface

dpaymentssdk_globalcharge_do_credit($res);

Remarks

This transaction adds funds to the cardholder's account. This can be performed any time and in any batch, and unlike the Refund method, is not based on a previous transaction.

Manually keyed credit: class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2015 class.CardEntryDataSource = edsManuallyEntered class.TransactionAmount = "1.00" 'credits $1.00 class.Credit()

Force Method (DPaymentsSDK_GlobalCharge Class)

Sends a Voice Authorization (Force) transaction to the Global Payments Server.

Object Oriented Interface

public function doForce($approvalcode);

Procedural Interface

dpaymentssdk_globalcharge_do_force($res, $approvalcode);

Remarks

Force transactions are typically used when a customer's card was declined, but the merchant was able to call the issuer and receive a voice authorization code. The Force method will add the transaction into the current open batch. The TransactionAmount, Card, and all other data must match exactly to the information given over the phone to receive the voice authorization, and the ApprovalCode parameter must be set with the authorization code you received. For example class.TransactionAmount = "1.00"; class.Force("123456"); // value from voice auth or previous AuthOnly trans

Interrupt Method (DPaymentsSDK_GlobalCharge Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_globalcharge_do_interrupt($res);

Remarks

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

Refund Method (DPaymentsSDK_GlobalCharge Class)

Refunds a previous transaction.

Object Oriented Interface

public function doRefund($pnref);

Procedural Interface

dpaymentssdk_globalcharge_do_refund($res, $pnref);

Remarks

This method issues a refund based on a previously authorized and settled transaction (Either a Sale, Capture, or Force). A transaction can only be refunded if it exists in a previous batch. (If the transaction is in the current open batch, use VoidTransaction instead). To process a refund, call Refund with the PNRef parameter set to the PNRef returned in response from the transaction for which you wish to issue a refund and set the TransactionAmount to the amount you wish to refund. You may issue a partial refund for any value up to the original sale amount. For example:

Full Refund: class.TransactionAmount = "25.00"; // Original transaction was for $25.00, so this is a full refund class.Refund("123456"); // "123456" is the PNRef from the original transaction Partial Refund: class.TransactionAmount = "15.00"; // Original transaction was for $25.00, so this is a partial refund class.Refund("123456"); // "123456" is the PNRef from the original transaction

If you do not know the PNRef from the original transaction, use Credit instead.

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

RepeatSale Method (DPaymentsSDK_GlobalCharge Class)

Used to submit a recurring transaction.

Object Oriented Interface

public function doRepeatSale($pnref);

Procedural Interface

dpaymentssdk_globalcharge_do_repeatsale($res, $pnref);

Remarks

The RepeatSale transaction can be used by merchants to enable simplified re-use of cards previously used by a customer, as well as for recurring transactions. By using the Global Transport Gateway's RepeatSale transaction instead of a new Sale transaction, sensitive cardholder data such as the card number and expiration date do not have to be stored locally by the merchant, which reduces the likelihood of that cardholder data being compromised. Because all sensitive cardholder data is stored by Global Payments, the merchant only needs to store PNRef numbers.

Keep in mind that the recurring logic (how often the transactions are processed, the length of contract, etc.) must be managed by the merchant and is not a function of the RepeatSale transaction feature of the Global Transport Gateway. Please note that PNRef numbers and cardholder data are only stored for 24 months from the date of the last activity on the Global Transport Gateway.

In order to perform a RepeatSale transaction, an initial Sale (or Partial Authorization) transaction must occur first. Once the original transaction is processed, the merchant should store the PNRef number that is returned in the transaction response. The merchant should always use the PNRef number of the most recent RepeatSale transaction Response for future re-use or recurring payments. An example is shown below: class.UserId = "4dpayments_ecom"; class.Password = "Passw0rd"; class.Card.Number = "4003000123456781"; class.Card.ExpMonth = 12; class.Card.ExpYear = 15; class.TransactionAmount = "8.00"; class.InvoiceNumber = "1234567890"; class.Sale("564474"); String pnref = class.Response.PNRef; class.Reset(); class.UserId = "4dpayments_ecom"; class.Password = "Passw0rd"; class.TransactionAmount = "8.00"; class.InvoiceNumber = "1234567890"; class.RepeatSale(pnref);

Reset Method (DPaymentsSDK_GlobalCharge Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_globalcharge_do_reset($res);

Remarks

This method clears all properties to their default values.

Reverse Method (DPaymentsSDK_GlobalCharge Class)

Reverses a transaction in the current batch.

Object Oriented Interface

public function doReverse($pnref);

Procedural Interface

dpaymentssdk_globalcharge_do_reverse($res, $pnref);

Remarks

A credit card Reversal transaction removes an unsettled, previously-submitted transaction. The PNRef parameter should be set to the PNRef from the transaction response of the transaction you wish to cancel.

A Reverse transaction differs from a VoidTransaction in one key way. A standard credit card sale puts a hold on the cardholder's open-to-buy funds until the batch is settled. If submitting a VoidTransaction, no money changes hands but a hold on the funds remains for a certain amount of time (usually around 7 days, depending on the issuing bank). A Reverse transaction releases the hold on the funds, and makes the funds available again immediately.

When two Reverse requests for the same transaction are submitted, a Reversal only occurs on the first transaction. If a Reversal request is submitted on a transaction which has already been reversed, Global Transport returns a "NO TRANS FOUND" message in the Response. Some standard card issuers may not support a Reversal. In this case, Global Transport returns a "DECLINE" response message. In this case, you should void it with the VoidTransaction method instead.

Sale Method (DPaymentsSDK_GlobalCharge Class)

Sends a Sale transaction to the host.

Object Oriented Interface

public function doSale();

Procedural Interface

dpaymentssdk_globalcharge_do_sale($res);

Remarks

A basic Sale transaction. This transaction decrements the cardholder's open-to-buy funds for the sale amount. This transaction is automatically added to the current open batch, and will be settled after the current batch is settled. The batch settlement may be set up to occur automatically, or you can control when the batch settles with the GlobalBatchMgr class. Sample transactions follow.

Sale transaction with Track 1 data: class.CardEntryDataSource = edsMagneticStripe class.CardMagneticStripe = "5499990123456781=15125025432198712345" class.TransactionAmount = "1.00" class.Sale() Manually keyed Sale transaction: class.CardEntryDataSource = edsManuallyEntered class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2015 class.TransactionAmount = "1.00" class.Sale()

TipAdjustment Method (DPaymentsSDK_GlobalCharge Class)

This methods adds a tip to the original sale transaction.

Object Oriented Interface

public function doTipAdjustment($pnref, $gratuityamount);

Procedural Interface

dpaymentssdk_globalcharge_do_tipadjustment($res, $pnref, $gratuityamount);

Remarks

To add a tip to a transaction simply call TipAdjustment with the PNRef parameter set to the PNRef of the transaction you wish to adjust, and the GratuityAmount to the amount you wish to add.

VoidTransaction Method (DPaymentsSDK_GlobalCharge Class)

Voids a transaction in the current batch.

Object Oriented Interface

public function doVoidTransaction($pnref);

Procedural Interface

dpaymentssdk_globalcharge_do_voidtransaction($res, $pnref);

Remarks

A Void removes transactions from an open batch prior to settlement, to correct same-day transaction mistakes. A transaction can only be voided if it exists in the current open batch. To do so, call VoidTransaction with the PNRef parameter set to the PNRef of the original transaction. This only works for transactions that are still in the current open batch. If the batch that contained the target transaction has already been settled, you must use the Refund or Credit methods instead.

Note that since AuthOnly transactions are not added to the current batch, they cannot be voided. Examples follow.

class.CardNumber = "4444333322221111" class.CardExpMonth = 1 class.CardExpYear = 2015 class.TransactionAmount = "1.00" class.Sale() refNumToVoid = class.ResponsePNRef ... more sale transactions ... 'All that's needed for a void: class.VoidTransaction(refNumToVoid)

Error Event (DPaymentsSDK_GlobalCharge Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_globalcharge_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'

Remarks

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

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

SSLServerAuthentication Event (DPaymentsSDK_GlobalCharge Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_globalcharge_register_callback($res, 2, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
'certsubject'
'certissuer'
'status'
'accept'

Remarks

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

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

SSLStatus Event (DPaymentsSDK_GlobalCharge Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_globalcharge_register_callback($res, 3, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Status Event (DPaymentsSDK_GlobalCharge Class)

Shows the progress of the Global Payments connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dpaymentssdk_globalcharge_register_callback($res, 4, array($this, 'fireStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (GlobalCharge Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

GlobalCharge Config Settings

CardPresent:   Overrides merchant settings to perform a card present or card not present transaction.

This setting may be used when processing keyed transactions in the Retail or Restaurant markets. The valid values are:

0Do not send CardPresent indicator (default)
1Card present
2Card not present.

If a Retail or Restaurant keyed transaction is submitted and CardPresent is set to 0, the Global Transport Gateway defaults the value to Card Present. If a MOTO or eCommerce transaction is submitted and CardPresent is set to 0, the Global Transport Gateway defaults to Card Not Present.

CardVerify:   Whether the transaction type is CardVerify.

Whether the transaction type is CardVerify. To use CardVerify transaction type when calling AVSOnly set this configuration setting to True.

By default this is set to False.

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

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

TrueDevice is only capable of accepting chip inserted EMV transactions.
FalseDevice is capable of accepting contactless EMV transactions. (default)
DuplicateChecking:   Enables or disables duplicate transaction checking.

Set to "On" (default) to enable duplicate checking, and "Off" to disable it. When duplicate checking is enabled, the Global Payments server will decline duplicate transactions.

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

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

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

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

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

EMVEntryDataSource:   The EMV Data Entry Source (DES).

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

Valid values are:

Value Device Capability Comments
0 EMV Valid for EMV chip card transactions.
1 EMV Contactless Valid for EMV contactless transactions.
2 EMV Kiosk Valid for EMV chip card transactions performed in a kiosk environment and should only be submitted with a Transaction Type of Sale.
3 EMV Kiosk Contactless Valid for EMV contactless transactions performed in a kiosk environment and should only be submitted with a Transaction Type of Sale.
4 EMV Swipe Valid when the original EMV chip card or EMV contactless transactions could not be completed, requiring a fallback to magnetic card swipe.
5 EMV Manual Valid when the original EMV chip card or EMV contactless transactions could not be completed, requiring a fallback to manually keyed.

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

EMVOnlineKSN:   Clear-text Key Sequence Number for EMV Online PIN transactions.

This field is used along with EMVOnlinePIN to perform EMV online PIN transactions. The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. This value must be 16 characters in length.

EMVOnlinePIN:   DUKPT DES encrypted PIN block for EMV Online PIN transactions.

This field is used along with EMVOnlineKSN to perform EMV online PIN transactions. The value of this property must be retrieved from a certified PIN pad device. This property is only valid for Card Present transactions. This value must be 16 characters in length.

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

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

TrueDevice is capable of accepting PINs.
FalseDevice is not capable of accepting PINs. (default)
PNRef:   Uniquely identifies the transaction in the Global Transport Gateway.

This value should be stored by the POS to enable the processing of subsequent transactions. For instance, Capture, Void, Refund, TipAdjustment, etc.

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

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

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

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

ResponseEMVData:   The response EMV data.

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

TCPClient Config Settings

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

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

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

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

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

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

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

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

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

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

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

FirewallPort:   The TCP port for the FirewallHost;.

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

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

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

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

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

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

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

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

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

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

Note: This value is not applicable in macOS.

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

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

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

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

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

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

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

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

LingerTime:   Time in seconds to have the connection linger.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MaxTransferRate:   The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.nsoftware.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

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

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

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

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

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

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

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

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

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

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

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

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

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

ReuseSSLSession:   Determines if the SSL session is reused.

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

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

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

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

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

The default value is:

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

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

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

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

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

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

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.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

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

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

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

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

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

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

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

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

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

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

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

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

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

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

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

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

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

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

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

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

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

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

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

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

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

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

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

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

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

SSLSecurityFlags:   Flags that control certificate verification.

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

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

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

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

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

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

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

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

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

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

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

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

TLS12SupportedGroups:   The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

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

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

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

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

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

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

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

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

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

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

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

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

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

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

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

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

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

Socket Config Settings

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

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

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

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

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

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

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

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

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

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

Base Config Settings

BuildInfo:   Information about the product's build.

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

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

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

The following is a list of valid code page identifiers:

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

LicenseInfo:   Information about the current license.

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

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

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

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

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

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

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

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

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

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

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

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

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

Trappable Errors (GlobalCharge Class)

GlobalCharge Errors

432   Invalid index.
501   Invalid length for this property.
502   Invalid data format for this property.
503   Value is out of range.
504   Credit card digit check failed.
505   Card date invalid.
506   Card expired.
519   Corrupt response.
520   Response payload empty.
526   Invalid timeout value.
593   A property required for this transaction is missing.
529   Error in XML response.
533   Internal error constructing payload.

The class may also return one of the following error codes, which are inherited from other classes.

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.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

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

SSL Errors

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

TCP/IP Errors

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