E-Payment Integrator 2022 C++ Builder Edition
Version 22.0 [Build 8593]

ECheck Component

Properties   Methods   Events   Config Settings   Errors  

The ECheck component is used to process Electronic Check (ACH) transactions through Internet Payment services such as the Authorize.Net eCheck.Net service.

Syntax

TibpECheck

Remarks

The ECheck component allows you to use multiple Internet Payment Gateways through one interface and one component. This allows for easy migration from one gateway to another, as well as quick integration into applications or web services.

The ECheck component allows your website to securely process electronic checks without the need to redirect to a third-party site. All transactions are accomplished through a secure HTTPS Post to any supported gateway. The secure response is received and then stored in the component's response properties. Any web site on a standard HTTP server or any stand-alone application can process transactions without the need for a secure server or third-party intervention.

The first thing you must do is select one of the gateways supported by the ECheck component, and set up an account with that gateway vendor. Once you have an account set up with a valid (or test) login Id and password, you can use the ECheck component.

To begin, set the Gateway property to the gateway you wish to use. If this gateway supports an alternate URL to send test transactions to, set the GatewayURL at this time.

Next, set the MerchantLogin (and for some gateways the MerchantPassword). These are supplied by your gateway vendor when you set up an account.

Now you are ready to process transactions. Not all gateways process ACH or eCheck transactions the same way. While all gateways require a bank routing and account number, some require additional information such as a driver's license number, bank name, or the account type (checking or savings). The gateways and their required properties are listed in the Gateway property.

Once all your properties are set, simply call the Authorize method. If your gateway supports it, you may also credit bank accounts with the Credit method.

The following gateways are supported by the ECheck component:

GatewayHome page
No Gateway (0) n/a
Authorize.Net AIM(1)http://www.authorize.net
eProcessing Transparent Database Engine(2)http://www.eProcessingNetwork.com
iTransact RediCharge HTML (4)http://www.itransact.com
NetBilling DirectMode (5)http://www.netbilling.com
PayFlow Pro (6)https://www.paypal.com/webapps/mpp/payflow-payment-gateway
USA ePay CGI Transaction Gateway (7)http://www.usaepay.com
Plug 'n Pay (8)http://www.plugnpay.com
Planet Payment iPay(9)http://planetpayment.com/
MPCS (10)http://merchantcommerce.net/
RTWare (11)http://www.rtware.net/
ECX (12)http://www.ecx.com
Merchant Anywhere (Transaction Central) (15)http://www.merchantanywhere.com/
TrustCommerce API (19)http://www.trustcommerce.com
PayFuse XML (ClearCommerce Engine) (21)http://www.firstnationalmerchants.com/
PayFlow Link (22)https://www.paypal.com/webapps/mpp/payflow-payment-gateway
Chase Paymentech Orbital Gateway (23)https://merchantservices.chase.com/
LinkPoint (24)http://www.linkpoint.com
Fast Transact VeloCT (Direct Mode) (27)http://www.fasttransact.com/
NetworkMerchants Direct-Post API (28)http://www.nmi.com/
TransFirst Transaction Central Classic (formerly PRIGate) (30)www.transfirst.com
Merchant Partners (Transaction Engine) (31)http://www.merchantpartners.com/
CyberCash (32)https://www.paypal.com/cybercash
First Data Global Gateway (Linkpoint) (33)http://www.firstdata.com
YourPay (34) (Linkpoint) http://www.yourpay.com
ACH Payments AGI (35)http://www.ach-payments.com
Forte AGI / Payments Gateway AGI(36)https://www.forte.net/
Cyber Source SOAP API (37)http://www.cybersource.com
goEmerchant XML (39)http://www.goemerchant.com/
TransFirst eLink (40)http://www.transfirst.com
Chase Merchant Services (Linkpoint) (41)http://www.chase.com
Thompson Merchant Services NexCommerce (iTransact mode) (42)http://www.thompsonmerchant.com
TransFirst Transaction Central (44)http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate)
Sterling SPOT XML API (HTTPS POST) (45)http://www.sterlingpayment.com
Sage Payment Solutions (Bankcard HTTPS Post protocol) (50)http://www.sagepayments.com
Verifi Direct-Post API (54)http://www.verifi.com
Intuit QuickBooks Merchant Services (QBMS) (61)This gateway is no longer in service. It has been replaced by Quickbooks Payments (113).
Heartland POS Gateway (62)http://www.heartlandpaymentsystems.com/
Litle Online Gateway (63)http://www.litle.com/
BrainTree DirectPost (Server-to-Server) Gateway (64)http://www.braintreepaymentsolutions.com/
JetPay Gateway (65)http://www.jetpay.com/
HSBC XML API (ClearCommerce Engine) (66)https://www.business.hsbc.uk/en-gb/payments/business-card
BluePay 2.0 Post (67)http://www.bluepay.com
Adyen API Payments (68)http://www.adyen.com
PayTrace Payment Gateway (70)https://www.paytrace.net/
OmniFund HTTP API / GoToBilling(73)http://omnifund.com/
TransNational Bankcard (74)http://www.tnbci.com/
Netbanx (75)http://www.netbanx.com/
ACH Federal (78)http://www.achfederal.com/
Bluefin (82)http://www.bluefin.com/
Payscape (83)http://www.payscape.com
Pay Direct (Link2Gov) (84)https://www.fisglobal.com/solutions/other/government/
WorldPay US Link Gateway (87)https://www.worldpay.com/en-us/index
First Data PayPoint (90)https://www.firstdata.com/en_us/customer-center/financial-institutions/paypoint.html
PhoeniXGate Gateway (97)http://www.phoenixmanagednetworks.com/
Repay Gateway (98)https://www.repay.com/
BlueSnap Gateway (104)https://home.bluesnap.com/
BASYS Gateway (106)https://basyspro.com/
Quickbooks Payments (113)https://quickbooks.intuit.com/payments/
Heartland Portico Gateway (116)http://www.heartlandpaymentsystems.com/

Property List


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

BankAccountClassIndicates whether a personal or business account is used for this transaction.
BankAccountHolderNameAccount holder's name.
BankAccountNumberBank account number for ACH transactions.
BankAccountTypeIndicates whether a checking or savings account is used for this transaction.
BankNameName of the account holder's bank.
BankRoutingNumberRouting number for ACH transactions.
CheckNumberIndicates the check number to use for a transaction.
CompanyNameThe Company Name.
CustomerAddressCustomer's street address.
CustomerAddress2A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.
CustomerAggregateThis property allows you to get or set an XML aggregate built from all of the Customer properties.
CustomerCityCustomer's city.
CustomerCountryCustomer's country.
CustomerEmailCustomer's email address.
CustomerFaxCustomer's fax number.
CustomerFirstNameCustomer's first name.
CustomerFullNameCustomer's full name.
CustomerIdMerchant-generated customer Id.
CustomerLastNameCustomer's last name.
CustomerPhoneCustomer's phone number.
CustomerStateCustomer's state.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
GatewayGateway to process transactions with.
GatewayURLDefault URL for a specific Gateway .
InvoiceNumberMerchant-generated invoice number.
LicenseDOBCustomer's Date of Birth as indicated on his driver's license.
LicenseNumberCustomer's drivers license number.
LicenseStateState in which customer's drivers license was issued.
MerchantLoginMerchant's Gateway login.
MerchantPasswordMerchant's Gateway password.
PaymentTypeThe type of check payment request (commonly referred to as SEC Code).
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component 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 user name, if authentication is to be used for the proxy.
ResponseApprovalCodeContains an authorization code when a transaction has been approved.
ResponseApprovedIndicates the status of the last transaction.
ResponseApprovedAmountThe amount approved for the transaction, this is the amount actually charged to the credit card.
ResponseAVSResultContains the Address Verification System result code.
ResponseCodeIndicates the status of the authorization request.
ResponseCVVResultContains the returned CVV2 result code if it was requested.
ResponseDataThe entire response returned from the gateway processor.
ResponseErrorCodeAdditional error code returned by some gateways.
ResponseErrorTextAdditional error description returned by some gateways.
ResponseInvoiceNumberInvoice number submitted in authorization request (if applicable).
ResponseProcessorCodeResponse code from the underlying processor.
ResponseTextText information that describes each response code.
ResponseTransactionIdContains the Visa Transaction Identifier or MasterCard Reference Number.
SpecialFieldCountThe number of records in the SpecialField arrays.
SpecialFieldNameName of special configuration property to submit in this transaction.
SpecialFieldValueValue of special configuration property to submit in this transaction.
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).
TaxIdCompany's Tax Id or a Customer's Social Security Number.
TestModeTurns test mode on and off for transactions sent to the current Gateway .
TimeoutA timeout for the component.
TransactionAmountPurchase amount for an authorization or retry transaction. Not used for reversals.
TransactionDescDescription of goods purchased.
TransactionIdMerchant-generated transaction Id used for all transactions.

Method List


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

AddSpecialFieldAdds a special field name and the corresponding value.
AuthorizeInitiates a check authorization transaction.
ConfigSets or retrieves a configuration setting.
CreditCredits a previous ACH transaction.
DoEventsProcesses events from the internal message queue.
GetResponseVarParses additional information out of the response.
InterruptInterrupts the current action.
ResetClears all properties to their default values.
ResetSpecialFieldsResets all special fields to the default settings.
VoidTransactionVoids a previously authorized transaction.

Event List


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

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Config Settings


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

AccountTokenA token representing a bank account.
AmountFormatUsed to set the input format for TransactionAmount.
AuthCodeAuthorization code from a previous transaction.
AuthNetOpaqueDescriptorAn Authorize.Net opaque data descriptor.
AuthNetOpaqueValueAn Authorize.Net opaque data value.
BASYSCheckInfoKeyBASYS Gateway Check Info Key.
BASYSGovernmentCheckDetermines whether the check is a government Check.
BASYSProcessRecurringCheckDetermines whether to process the transaction using Check Info Key.
BlueSnapEnterpriseUdfsUser-Defined Fields (UDFs) to send with a BlueSnap Authorize request.
BlueSnapRetrieveTransactionRetrieves a BlueSnap transaction.
BlueSnapTransactionMetaDataTransaction metadata to send with a BlueSnap Authorize request.
CheckRoutingNumberDetermines whether to perform a checksum test on the RoutingNumber.
CurrencyCodeCurrency code for the currency of the transaction.
CurrencyExponentCurrency exponent to be used in conjunction with the Currency code of the transaction.
CyberSourceXMLEscapeDetermines whether to XML escape the CyberSource gateway request field values.
EscapeXMLAutomatically escape data within XML tags.
GoEMerchantUseGatewayIdIndicates whether to send a password or gateway Id for the GoEMerchant gateway.
HashSecretSecurity key used to generate a hash for gateways supporting such functionality.
HeartlandDeveloperIdOptional DeveloperId field used by the Heartland gateway.
HeartlandDeviceIdDeviceId field required by the Heartland gateway.
HeartlandLicenseIdLicenseId field required by the Heartland gateway.
HeartlandSecretAPIKeySpecifies the secret key to be used for authentication with Heartland.
HeartlandSiteIdSiteId field required by the Heartland gateway.
HeartlandSiteTraceOptional transaction identifier for the Heartland gateway.
HeartlandStoreIdStoreId for the Heartland (62) gateway.
HeartlandVersionNumberOptional VersionNumber field used by the Heartland gateway.
MerchantAliasAn additional merchant property used to specify an alias for the merchant.
MerchantCodeRequired field for the Litle gateway.
MerchantPartnersLast4DigitsThe last 4 digits of the account number for a transaction processed via the MerchantPartners gateway.
MerchantPartnersProfileIdThe profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways.
NetbanxAccountNumberAccount Number for the Netbanx gateway.
NetBillingVersionThe Version to be sent in the User-Agent heading of a NetBilling gateway request.
OrbitalConnectionPasswordOrbital Connection Password field used by the Orbital gateway.
OrbitalConnectionUsernameOrbital Connection Username field used by the Orbital gateway.
OrbitalCustomerProfileFromOrderIndCustomer Profile Number generation Options for the Orbital gateway.
OrbitalCustomerProfileOrderOverrideIndIndicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway.
PayDirectConvenienceFeeThe total convenience fee charged when using the PayDirect gateway.
PayDirectMerchantAmountThe MerchantAmount used by the PayDirect gateway.
PayDirectSettleMerchantCodeThe Settle Merchant Code required for authorization when using the PayDirect gateway.
PayerIPThe IP address of the payer.
PayFlowProInquirySubmits an Inquiry transaction to the PayFlowPro gateway.
PhoeniXGateCheckInfoKeyPhoeniXGate Gateway Check Info Key.
PhoeniXGateGovernmentCheckDetermines whether the check is a government Check.
PhoeniXGateProcessRecurringCheckDetermines whether to process the transaction using Check Info Key.
RawRequestReturns the data that was sent to the gateway.
RawResponseReturns the data that was received from the gateway.
RepayCheckInfoKeyRepay Gateway Check Info Key.
RepayGovernmentCheckDetermines whether the check is a government Check.
RepayProcessRecurringCheckDetermines whether to process the transaction using Check Info Key.
TerminalIdTerminal Id value sent in the transaction.
TerminalIdTerminal Id number for the BluePay gateways.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component 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 component 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.
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 ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
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.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

BankAccountClass Property (ECheck Component)

Indicates whether a personal or business account is used for this transaction.

Syntax

__property TibpECheckBankAccountClass BankAccountClass = { read=FBankAccountClass, write=FSetBankAccountClass };
enum TibpECheckBankAccountClass { acPersonal=0, acBusiness=1 };

Default Value

acPersonal

Remarks

Indicates whether a personal or business account is used for this transaction.

Available values:

Value Definition
acPersonal (0) Personal Account.
acBusiness (1) Business Account.

This property is not available at design time.

Data Type

Integer

BankAccountHolderName Property (ECheck Component)

Account holder's name.

Syntax

__property String BankAccountHolderName = { read=FBankAccountHolderName, write=FSetBankAccountHolderName };

Default Value

""

Remarks

Account holder's name. This property contains the customer's name as it appears on their account. Many gateways use this property in addition to, or instead of, the Customer Firsts and Last name properties. Note that if this property is not specified, the FullName property from the EPCustomer type will be used instead.

This property is not available at design time.

Data Type

String

BankAccountNumber Property (ECheck Component)

Bank account number for ACH transactions.

Syntax

__property String BankAccountNumber = { read=FBankAccountNumber, write=FSetBankAccountNumber };

Default Value

""

Remarks

Bank account number for ACH transactions. This property contains the customer's bank account number, which along with the BankRoutingNumber identify the location of the account where funds are to be drawn from for ACH transactions. This property is required for all ACH transactions.

This property is not available at design time.

Data Type

String

BankAccountType Property (ECheck Component)

Indicates whether a checking or savings account is used for this transaction.

Syntax

__property TibpECheckBankAccountTypes BankAccountType = { read=FBankAccountType, write=FSetBankAccountType };
enum TibpECheckBankAccountTypes { atChecking=0, atSavings=1 };

Default Value

atChecking

Remarks

Indicates whether a checking or savings account is used for this transaction. For gateways that support it, this property allows funds to be withdrawn (or added in the case of a Credit) from either the customer's Checking or Savings account.

Available values:

Value Definition
atChecking (0) Checking Account.
atSavings (1) Savings Account.

This property is not available at design time.

Data Type

Integer

BankName Property (ECheck Component)

Name of the account holder's bank.

Syntax

__property String BankName = { read=FBankName, write=FSetBankName };

Default Value

""

Remarks

Name of the account holder's bank. For example, Citibank, Wells-Fargo, Wachovia, etc. This property contains the name of the bank associated with the BankRoutingNumber.

This property is not available at design time.

Data Type

String

BankRoutingNumber Property (ECheck Component)

Routing number for ACH transactions.

Syntax

__property String BankRoutingNumber = { read=FBankRoutingNumber, write=FSetBankRoutingNumber };

Default Value

""

Remarks

Routing number for ACH transactions. This property contains the routing number to the customer's bank (Also known as an ABA code). This number indicates at which bank the BankAccountNumber is located, and is used to identify the location of the account where funds are to be drawn from for ACH transactions. This property is required for all ACH transactions.

Note: When using ACHPayments gateway, a leading zero must be added for Canadian bank accounts.

This property is not available at design time.

Data Type

String

CheckNumber Property (ECheck Component)

Indicates the check number to use for a transaction.

Syntax

__property String CheckNumber = { read=FCheckNumber, write=FSetCheckNumber };

Default Value

""

Remarks

This optional property allows the customer to select a check number to use for this ACH transaction. This property is only supported by the iTransact and NetBilling gateways.

Data Type

String

CompanyName Property (ECheck Component)

The Company Name.

Syntax

__property String CompanyName = { read=FCompanyName, write=FSetCompanyName };

Default Value

""

Remarks

This property contains the Company Name associated with the billing address.

Data Type

String

CustomerAddress Property (ECheck Component)

Customer's street address.

Syntax

__property String CustomerAddress = { read=FCustomerAddress, write=FSetCustomerAddress };

Default Value

""

Remarks

Customer's street address. This property is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in This property. City, state, and zip code are set in the CustomerCity, CustomerState, and CustomerZip properties.

The length of this property varies by gateway. If the customer's address is very long, it is admissible to include only the street number in This property.

NOTE: For the Moneris gateway, this property should contain only the customer's street number. The street name should be added via the AddSpecialField method. For example:

component.CustomerAddress = "123" component.AddSpecialField("avs_street_name", "Nowhere Ln")

This property is not available at design time.

Data Type

String

CustomerAddress2 Property (ECheck Component)

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.

Syntax

__property String CustomerAddress2 = { read=FCustomerAddress2, write=FSetCustomerAddress2 };

Default Value

""

Remarks

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).

This property is not available at design time.

Data Type

String

CustomerAggregate Property (ECheck Component)

This property allows you to get or set an XML aggregate built from all of the Customer properties.

Syntax

__property String CustomerAggregate = { read=FCustomerAggregate, write=FSetCustomerAggregate };

Default Value

""

Remarks

This property allows you to get or set an XML aggregate built from all of the Customer properties. "EPCustomer" is the root element. The Customer properties make up the tags under the root, but without the beginning "Customer". For instance: <EPCustomer> <Address>123 Nowhere Ln.</Address> <Address2>Apt 3B.</Address2> <City>Beverly Hills</City> ... </EPCustomer>

This property is not available at design time.

Data Type

String

CustomerCity Property (ECheck Component)

Customer's city.

Syntax

__property String CustomerCity = { read=FCustomerCity, write=FSetCustomerCity };

Default Value

""

Remarks

Customer's city. This property is used as part of the Address Verification Service (AVS) and contains the customer's city as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerState, and CustomerZip.

This property is not available at design time.

Data Type

String

CustomerCountry Property (ECheck Component)

Customer's country.

Syntax

__property String CustomerCountry = { read=FCustomerCountry, write=FSetCustomerCountry };

Default Value

""

Remarks

Customer's country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.

Note: If using this property with the PayFuse gateway, this property should contain the ISO-3166 numeric code instead of the standard two-letter code. For example, the ISO code for the US is "840".

This property is not available at design time.

Data Type

String

CustomerEmail Property (ECheck Component)

Customer's email address.

Syntax

__property String CustomerEmail = { read=FCustomerEmail, write=FSetCustomerEmail };

Default Value

""

Remarks

Customer's email address. This optional property contains the customer's email address.

This property is not available at design time.

Data Type

String

CustomerFax Property (ECheck Component)

Customer's fax number.

Syntax

__property String CustomerFax = { read=FCustomerFax, write=FSetCustomerFax };

Default Value

""

Remarks

Customer's fax number. This optional property contains the customer's fax number.

This property is not available at design time.

Data Type

String

CustomerFirstName Property (ECheck Component)

Customer's first name.

Syntax

__property String CustomerFirstName = { read=FCustomerFirstName, write=FSetCustomerFirstName };

Default Value

""

Remarks

Customer's first name. This property contains the customer's first name.

This property is not available at design time.

Data Type

String

CustomerFullName Property (ECheck Component)

Customer's full name.

Syntax

__property String CustomerFullName = { read=FCustomerFullName, write=FSetCustomerFullName };

Default Value

""

Remarks

Customer's full name. This property contains the customer's full name as it appears on the credit card or bank account. Many gateways use this property in addition to, or instead of, the CustomerFirstName and CustomerLastName properties. If a gateway requires a CustomerFullName and the property is empty, CustomerFullName will be constructed using the contents of CustomerFirstName and CustomerLastName.

This property is not available at design time.

Data Type

String

CustomerId Property (ECheck Component)

Merchant-generated customer Id.

Syntax

__property String CustomerId = { read=FCustomerId, write=FSetCustomerId };

Default Value

""

Remarks

Merchant-generated customer Id. This property contains a merchant-generated customer identification number. This number should be unique for each different customer that places an order with the merchant.

This property is not available at design time.

Data Type

String

CustomerLastName Property (ECheck Component)

Customer's last name.

Syntax

__property String CustomerLastName = { read=FCustomerLastName, write=FSetCustomerLastName };

Default Value

""

Remarks

Customer's last name. This property contains the customer's last name as it appears on their credit card.

This property is not available at design time.

Data Type

String

CustomerPhone Property (ECheck Component)

Customer's phone number.

Syntax

__property String CustomerPhone = { read=FCustomerPhone, write=FSetCustomerPhone };

Default Value

""

Remarks

Customer's phone number. This optional property contains the customer's phone number.

This property is not available at design time.

Data Type

String

CustomerState Property (ECheck Component)

Customer's state.

Syntax

__property String CustomerState = { read=FCustomerState, write=FSetCustomerState };

Default Value

""

Remarks

Customer's state. This property is used as part of the Address Verification Service (AVS) and contains the two character postal abbreviation of the customer's state as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerZip.

This property is not available at design time.

Data Type

String

CustomerZip Property (ECheck Component)

Customer's zip code (or postal code if outside of the USA).

Syntax

__property String CustomerZip = { read=FCustomerZip, write=FSetCustomerZip };

Default Value

""

Remarks

Customer's zip code (or postal code if outside of the USA). This property is used as part of the Address Verification Service (AVS), and contains the customer's zip code as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerState.

This property is not available at design time.

Data Type

String

Gateway Property (ECheck Component)

Gateway to process transactions with.

Syntax

__property TibpECheckGateways Gateway = { read=FGateway, write=FSetGateway };
enum TibpECheckGateways { ecgwNoGateway=0, ecgwAuthorizeNet=1, ecgwEprocessing=2, ecgwITransact=4, ecgwNetBilling=5, ecgwPayFlowPro=6, ecgwUSAePay=7, ecgwPlugNPay=8, ecgwPlanetPayment=9, ecgwMPCS=10, ecgwRTWare=11, ecgwECX=12, ecgwMerchantAnywhere=15, ecgwTrustCommerce=19, ecgwPayFuse=21, ecgwPayFlowLink=22, ecgwOrbital=23, ecgwLinkPoint=24, ecgwFastTransact=27, ecgwNetworkMerchants=28, ecgwPRIGate=30, ecgwMerchantPartners=31, ecgwCyberCash=32, ecgwFirstData=33, ecgwYourPay=34, ecgwACHPayments=35, ecgwForte=36, ecgwCyberSource=37, ecgwGoEMerchant=39, ecgwTransFirst=40, ecgwChase=41, ecgwNexCommerce=42, ecgwTransactionCentral=44, ecgwSterling=45, ecgwSagePayments=50, ecgwVerifi=54, ecgwQBMS=61, ecgwHeartland=62, ecgwLitle=63, ecgwBrainTree=64, ecgwJetPay=65, ecgwHSBC=66, ecgwBluePay=67, ecgwAdyen=68, ecgwPayTrace=70, ecgwOmniFund=73, ecgwTransNationalBankcard=74, ecgwNetbanx=75, ecgwACHFederal=78, ecgwBluefin=82, ecgwPayscape=83, ecgwPayDirect=84, ecgw5thDimension=86, ecgwWorldPayLink=87, ecgwFirstDataPayPoint=90, ecgwAuthorizeNetXML=96, ecgwPhoeniXGate=97, ecgwRepay=98, ecgwBlueSnap=104, ecgwBASYS=106, ecgwQBPayments=113, ecgwHeartlandPortico=116 };

Default Value

ecgwNoGateway

Remarks

This property is used to select the gateway with which transactions will be processed. Setting the Gateway property will also fill the GatewayURL with the URL to the gateway's processing server, and will also fill the SpecialFieldName and SpecialFieldValue properties with default names and values for the selected gateway. These are special configuration values that should usually not be changed. The following table shows the currently supported gateways, as well as the corporate home page for each.

GatewayHome page
No Gateway (0) n/a
Authorize.Net AIM(1)http://www.authorize.net
eProcessing Transparent Database Engine(2)http://www.eProcessingNetwork.com
iTransact RediCharge HTML (4)http://www.itransact.com
NetBilling DirectMode (5)http://www.netbilling.com
PayFlow Pro (6)https://www.paypal.com/webapps/mpp/payflow-payment-gateway
USA ePay CGI Transaction Gateway (7)http://www.usaepay.com
Plug 'n Pay (8)http://www.plugnpay.com
Planet Payment iPay(9)http://planetpayment.com/
MPCS (10)http://merchantcommerce.net/
RTWare (11)http://www.rtware.net/
ECX (12)http://www.ecx.com
Merchant Anywhere (Transaction Central) (15)http://www.merchantanywhere.com/
TrustCommerce API (19)http://www.trustcommerce.com
PayFuse XML (ClearCommerce Engine) (21)http://www.firstnationalmerchants.com/
PayFlow Link (22)https://www.paypal.com/webapps/mpp/payflow-payment-gateway
Chase Paymentech Orbital Gateway (23)https://merchantservices.chase.com/
LinkPoint (24)http://www.linkpoint.com
Fast Transact VeloCT (Direct Mode) (27)http://www.fasttransact.com/
NetworkMerchants Direct-Post API (28)http://www.nmi.com/
TransFirst Transaction Central Classic (formerly PRIGate) (30)www.transfirst.com
Merchant Partners (Transaction Engine) (31)http://www.merchantpartners.com/
CyberCash (32)https://www.paypal.com/cybercash
First Data Global Gateway (Linkpoint) (33)http://www.firstdata.com
YourPay (34) (Linkpoint) http://www.yourpay.com
ACH Payments AGI (35)http://www.ach-payments.com
Forte AGI / Payments Gateway AGI(36)https://www.forte.net/
Cyber Source SOAP API (37)http://www.cybersource.com
goEmerchant XML (39)http://www.goemerchant.com/
TransFirst eLink (40)http://www.transfirst.com
Chase Merchant Services (Linkpoint) (41)http://www.chase.com
Thompson Merchant Services NexCommerce (iTransact mode) (42)http://www.thompsonmerchant.com
TransFirst Transaction Central (44)http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate)
Sterling SPOT XML API (HTTPS POST) (45)http://www.sterlingpayment.com
Sage Payment Solutions (Bankcard HTTPS Post protocol) (50)http://www.sagepayments.com
Verifi Direct-Post API (54)http://www.verifi.com
Intuit QuickBooks Merchant Services (QBMS) (61)This gateway is no longer in service. It has been replaced by Quickbooks Payments (113).
Heartland POS Gateway (62)http://www.heartlandpaymentsystems.com/
Litle Online Gateway (63)http://www.litle.com/
BrainTree DirectPost (Server-to-Server) Gateway (64)http://www.braintreepaymentsolutions.com/
JetPay Gateway (65)http://www.jetpay.com/
HSBC XML API (ClearCommerce Engine) (66)https://www.business.hsbc.uk/en-gb/payments/business-card
BluePay 2.0 Post (67)http://www.bluepay.com
Adyen API Payments (68)http://www.adyen.com
PayTrace Payment Gateway (70)https://www.paytrace.net/
OmniFund HTTP API / GoToBilling(73)http://omnifund.com/
TransNational Bankcard (74)http://www.tnbci.com/
Netbanx (75)http://www.netbanx.com/
ACH Federal (78)http://www.achfederal.com/
Bluefin (82)http://www.bluefin.com/
Payscape (83)http://www.payscape.com
Pay Direct (Link2Gov) (84)https://www.fisglobal.com/solutions/other/government/
WorldPay US Link Gateway (87)https://www.worldpay.com/en-us/index
First Data PayPoint (90)https://www.firstdata.com/en_us/customer-center/financial-institutions/paypoint.html
PhoeniXGate Gateway (97)http://www.phoenixmanagednetworks.com/
Repay Gateway (98)https://www.repay.com/
BlueSnap Gateway (104)https://home.bluesnap.com/
BASYS Gateway (106)https://basyspro.com/
Quickbooks Payments (113)https://quickbooks.intuit.com/payments/
Heartland Portico Gateway (116)http://www.heartlandpaymentsystems.com/

Data Type

Integer

GatewayURL Property (ECheck Component)

Default URL for a specific Gateway .

Syntax

__property String GatewayURL = { read=FGatewayURL, write=FSetGatewayURL };

Default Value

""

Remarks

This property is used to change the default URL for a specific Gateway. This is useful for specifying a different URL for testing purposes, or to support additional gateway processors that share a protocol format (such as additional Authorize.net compatible gateways). Please note that the proper "http://" or "https://" formatting must be observed. Some alternate testing URLs are listed below:

URLs for submitting test transactions: (not supported by all gateways)

ACH Paymentshttps://www.paymentsgateway.net/cgi-bin/posttest.pl
Fortehttps://www.paymentsgateway.net/cgi-bin/posttest.pl
CyberSourcehttps://ics2wstest.ic3.com/commerce/1.x/transactionProcessor/
Heartlandhttps://test.transmodus.net/jcx/soa/test/services/ACHWebService
LinkPointstaging.linkpt.net:1129
Litle Online Gatewayhttps://cert.litle.com/vap/communicator/online
Sterling XML Gatewayhttps://gateway.securenet.com/api/Gateway.svc/wsHttp
Netbanx Gatewayhttps://webservices.test.optimalpayments.com/directdebitWS/DirectDebitServlet/v1
ACH Federal Gatewayhttps://api.achfederal.com/webserviceSandbox/v2/gateway.asmx

Data Type

String

InvoiceNumber Property (ECheck Component)

Merchant-generated invoice number.

Syntax

__property String InvoiceNumber = { read=FInvoiceNumber, write=FSetInvoiceNumber };

Default Value

""

Remarks

This field contains a merchant-generated invoice number. This number should be unique for each transaction. This property is optional for most gateways, but it is recommended that the merchant use an invoice number to keep track of transactions. See the Gateway property to determine if this is a required or optional field for the gateway you are using.

Data Type

String

LicenseDOB Property (ECheck Component)

Customer's Date of Birth as indicated on his driver's license.

Syntax

__property String LicenseDOB = { read=FLicenseDOB, write=FSetLicenseDOB };

Default Value

""

Remarks

This property contains the customer's date of birth as it appears on his driver's license. The format varies between gateways, so please see the specifications for correct formatting. This property may be used by the gateway for fraud screening.

Data Type

String

LicenseNumber Property (ECheck Component)

Customer's drivers license number.

Syntax

__property String LicenseNumber = { read=FLicenseNumber, write=FSetLicenseNumber };

Default Value

""

Remarks

This property contains the customer's drivers license number. This property may be used by the gateway for fraud screening.

Data Type

String

LicenseState Property (ECheck Component)

State in which customer's drivers license was issued.

Syntax

__property String LicenseState = { read=FLicenseState, write=FSetLicenseState };

Default Value

""

Remarks

This property contains the two-digit abbreviated postal code indicating the state in which the customer's drivers license was issued. This property may be used by the gateway for fraud screening.

Data Type

String

MerchantLogin Property (ECheck Component)

Merchant's Gateway login.

Syntax

__property String MerchantLogin = { read=FMerchantLogin, write=FSetMerchantLogin };

Default Value

""

Remarks

This is the login Id supplied by the Gateway you signed up with to process credit card transactions.

Data Type

String

MerchantPassword Property (ECheck Component)

Merchant's Gateway password.

Syntax

__property String MerchantPassword = { read=FMerchantPassword, write=FSetMerchantPassword };

Default Value

""

Remarks

This is the password supplied by the Gateway you signed up with to process credit card transactions. Some gateways require passwords only for Credit or Void transactions, some require it for all transactions, and some do not require this field at all.

Data Type

String

PaymentType Property (ECheck Component)

The type of check payment request (commonly referred to as SEC Code).

Syntax

__property TibpECheckPaymentTypes PaymentType = { read=FPaymentType, write=FSetPaymentType };
enum TibpECheckPaymentTypes { ptWEB=0, ptPPD=1, ptTEL=2, ptCCD=3, ptARC=4, ptBOC=5, ptPOP=6, ptRCK=7 };

Default Value

ptWEB

Remarks

This property is used to specify the payment type of the check transaction.

Available values:

Value Definition
ptWEB (0) Internet Initiated Entry. Transaction was received from consumer via the Internet (ie shopping cart). Web transactions require a drop-down 'I agree' or a standard form of acknowledgment initiated by the customer.
ptPPD (1) Prearranged Payment or Deposit. Credits or Debits that have been pre-arranged by consumers to draft from their personal bank account. Typically used for recurring payments. Signed Authorization by Customer required, or contract language along with voided check.
ptTEL (2) Telephone Initiated Entry. Transaction information was received via the telephone. Transactions Authorization script must be recorded at the time the transaction is processed, or written acknowledgment sent to the customer.
ptCCD (3) Cash Concentration or Disbursement. Used for the transfer of funds between entities. Signed Authorization by Customer required.
ptARC (4) Accounts Receivable Conversion. Used for payments being made against a bill such as a utility. Signed Authorization by Customer required.
ptBOC (5) Back Office Conversion. Paper checks that are collected in a retail environment and then scanned and batched electronically. Customer notification 'Checks are Electronically Processed' required at Point of Sale.
ptPOP (6) Point-of-Purchase. Paper checks that are converted (scanned) into electronic format at the point of sale. The original paper check is voided and returned to the customer. Point of Sale is authorization.
ptRCK (7) Re-Presentation Check. After a check has been return for insufficient funds it may be attempted again using this format. RCK may only be retried once. Customer notification 'Returned Checks are Electronically Re-Processed' required at Point of Sale.

Data Type

Integer

ProxyAuthScheme Property (ECheck Component)

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

Syntax

__property TibpECheckProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };
enum TibpECheckProxyAuthSchemes { authBasic=0, authDigest=1, authProprietary=2, authNone=3, authNtlm=4, authNegotiate=5 };

Default Value

authBasic

Remarks

This property is used to tell the component 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 component. Look at the configuration file for the component 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 (ECheck Component)

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

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

ProxyPassword Property (ECheck Component)

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

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

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 (ECheck Component)

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

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

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 (ECheck Component)

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

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

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 (ECheck Component)

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

Syntax

__property TibpECheckProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };
enum TibpECheckProxySSLs { psAutomatic=0, psAlways=1, psNever=2, psTunnel=3 };

Default Value

psAutomatic

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 component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (ECheck Component)

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

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

This property contains a user name, 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

ResponseApprovalCode Property (ECheck Component)

Contains an authorization code when a transaction has been approved.

Syntax

__property String ResponseApprovalCode = { read=FResponseApprovalCode };

Default Value

""

Remarks

Contains an authorization code when a transaction has been approved. This property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction is not approved, then the contents of this property should be ignored.

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

Data Type

String

ResponseApproved Property (ECheck Component)

Indicates the status of the last transaction.

Syntax

__property bool ResponseApproved = { read=FResponseApproved };

Default Value

false

Remarks

Indicates the status of the last transaction. This property will be True if the last transaction was approved. However, you should not rely solely on the value contained in this property. After every transaction, the ResponseCode should be inspected and evaluated according to the specifications of the Gateway in use. A list of response codes for each gateway is listed in the table of contents. However, it is recommended that the developer acquire the current list from the Gateway which is being used.

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

Data Type

Boolean

ResponseApprovedAmount Property (ECheck Component)

The amount approved for the transaction, this is the amount actually charged to the credit card.

Syntax

__property String ResponseApprovedAmount = { read=FResponseApprovedAmount };

Default Value

""

Remarks

The amount approved for the transaction, this is the amount actually charged to the credit card.

This property is primarily used when gateways allow partial authorizations and AllowPartialAuths is 'True'. Thus this property is not used by all gateways and should not alone be used to determine if a transaction was successful (such as in the case that this property is not populated).

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

Data Type

String

ResponseAVSResult Property (ECheck Component)

Contains the Address Verification System result code.

Syntax

__property String ResponseAVSResult = { read=FResponseAVSResult };

Default Value

""

Remarks

Contains the Address Verification System result code. This one character property contains the Address Verification Service (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored for later retrieval, as it may be required when voiding or refunding a transaction. Valid AVS response codes are listed below, and are identical across all Gateway (note that some gateways do not return an AVS response).

ResponseAVSResultDescription
AAddress matches, Zip does not.
EAVS error.
GNon-U.S. issuing bank does not support AVS.
NNo match on Address or CustomerZip.
PAVS not applicable for this transaction.
RRetry - Issuer system unavailable.
SService not supported by issuer.
UAddress information is unavailable.
WNine digit Zip matches, Address does not.
XExact AVS match, nine digit Zip.
YExact AVS match, five digit Zip.
ZFive digit Zip matches, Address does not.

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

Adyen

For Adyen, this property will contain the following possible values:

0Unknown
1Address matches, postal code doesn't
2Neither postal code nor address match
3AVS unavailable
4AVS not supported for this card type
5No AVS data provided
6Postal code matches, address doesn't match
7Both postal code and address match
8Address not checked, postal code unknown
9Address matches, postal code unknown
10Address doesn't match, postal code unknown
11Postal code not checked, address unknown
12Address matches, postal code not checked
13Address doesn't match, postal code not checked
14Postal code matches, address unknown
15Postal code matches, address not checked
16Postal code doesn't match, address unknown
17Postal code doesn't match, address not checked
18Neither postal code nor address were checked

American Payment Solutions

For American Payment Solutions, this property will contain the following possible values:

XExact match, 9-character numeric ZIP
Y, D, or MExact match, 5-character numeric ZIP
2 or 6Exact match, 5-character numeric ZIP, customer name
A or BAddress match only
3 or 7Address, customer name match only
W9-character numeric ZIP match only
Z, P, or L5-character ZIP match only
1 or 55-character ZIP, customer name match only
N or CNo address or ZIP match only
4 or 8No address or ZIP or customer name match only
UAddress unavailable
G or INon-U.S. issuer does not participate
RIssuer system unavailable
ENot a mail/phone order
SService not supported
0, O, or BAVS not available

Barclay

For Barclay, the property will contain the following possible values:

YYAddress and zip code or postal code match
YNAddress matches only
NYZip code or postal code matches
NNNeither address nor zip code or postal code matches; address is not parsable
UUAddress information is unavailable, service is unavailable, or Error; Unknown
BlankNo AVS performed

BlueSnap

For BlueSnap, the property will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following properties:

1st CharacterName AVS check
2nd CharacterAddress AVS check
3rd CharacterPostal/Zip Code AVS check

The possible values for each result character are:

MMatches
NDoes not match
UCould not be verified

HSBC

For HSBC, the property will contain the following possible values:

YYAddress and zip code or postal code match
YNAddress matches only
NYZip code or postal code matches
NNNeither address nor zip code or postal code matches; address is not parsable
UUAddress information is unavailable, service is unavailable, or Error; Unknown
FFIssuer does not participate in AVS
BlankNo AVS performed

PayTrace / PayTraceJSON

For PayTrace / PayTraceJSON, the property will contain the following possible values:

Full Exact Match
Address Match Only
Zip Match Only
No Match
Address Unavailable
Non-US Issuer does not participate
Issuer System Unavailable
Not a Mail/Phone Order
Service Not Supported

QBMS

For the QBMS gateway, the ResponseAVSResult property will contain the result for the street address, a comma, and then the result for the zip code. The values returned are "Pass", "Fail", and "NotAvailable". Therefore, an ResponseAVSResult of "Fail,Pass" means that the street address failed validation, but the zip code passed.

DataCash

For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):

NO DATA MATCHES
ADDRESS MATCH ONLY
SECURITY CODE MATCH ONLY
ALL MATCH
DATA NOT CHECKED

Stripe

For Stripe, the property will contain the following possible values:

Pass The first address line or zip code provided is correct.
Fail The first address line or zip code provided is incorrect.
Unavailable The customer's bank did not check the first address line or zip code provided.
Unchecked The first address line or zip code was provided but has not yet been checked.

Worldpay

For Worldpay, the property will contain a 4-character string, which contains the AVS checks for the following properties:

1st CharacterCard Verification Value (CVV) check
2nd CharacterPostal/Zip Code AVS check
3rd CharacterAddress AVS check
4th CharacterCountry Comparison check

The possible values for each result character are:

0Not Supported.
1Not Checked.
2Matched.
4No Match.
8Partial Match.

Worldpay Online

For Worldpay Online, the property will contain one of the following:

ValueDescription
APPROVED The supplied street and postal code details fully matched the payment provider's records
PARTIAL APPROVED One of the supplied street or postal code details did not match the payment provider's records
NOT SENT TO ACQUIRER Problem with acquirer - possibly no AVS support
NO RESPONSE FROM ACQUIRERProblem with acquirer - possibly no AVS support
NOT CHECKED BY ACQUIRER The acquirer did not check the address details
NOT SUPPLIED BY SHOPPER Missing, incomplete or invalid address details in the order prevented the address from being checked
FAILED Both street and postal code details did not match the payment provider's records

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

Data Type

String

ResponseCode Property (ECheck Component)

Indicates the status of the authorization request.

Syntax

__property String ResponseCode = { read=FResponseCode };

Default Value

""

Remarks

Indicates the status of the authorization request. This property contains the actual response code as returned by the Gateway. Unlike the ResponseApproved property, this ResponseCode property may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the ResponseCode as well as the ResponseApproved property. The Point of Sale system should evaluate this response code and NOT the ResponseText to determine nature of a response message. The current (at the time of this release) response codes for the supported Gateways are listed in the table of contents to your left.

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

Data Type

String

ResponseCVVResult Property (ECheck Component)

Contains the returned CVV2 result code if it was requested.

Syntax

__property String ResponseCVVResult = { read=FResponseCVVResult };

Default Value

""

Remarks

Contains the returned CVV2 result code if it was requested. This property contains the host returned CVV2 result code (if CVV data was sent in the request). The following is a list of current result codes:

MCVV2 Match.
NCVV2 No Match.
PNot Processed.
SMerchant has indicated that CVV2 is not present on card.
UIssuer not certified and/or has not provided Visa encryption keys.

A gateway may also support custom codes or human-readable response messages in this property. Please consult your gateway documentation to determine if CVV2 codes are supported.

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

HSBC

For HSBC, the property will contain:

0Card type does not support CVM
1CVM match
2CVM did not match issuer value
3CVM was not processed
4CVM should be on the card but cardholder indicated otherwise
5CVM not supported by issuer
6Not valid
7No response from server

Adyen

For Adyen, the property will contain:

0Unknown
1Matches
2Does not match
3Not checked
4No CVC/CVV provided, but was required
5Issuer not certified for CVC/CVV
6No CVC/CVV provided

Barclay

For Barclay, the property will contain:

0,1CVM was not processed
2CVM match
4CVM does not match issuer value
UnknownCVM invalid or missing
BlankNo response from server

BlueSnap

For BlueSnap, the property will contain:

MAMatch
NCIssuer is not certified for CVV2/CVC2/CID
NDCheck was not done
NMNo match
NPCVV2/CVC2/CID should be on the card but is not present
NRCVV check not requested

(Note: There are some scenarios in which the property will be empty instead, refer to BlueSnap's documentation for more details.)

DataCash

For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):

NO DATA MATCHES
ADDRESS MATCH ONLY
SECURITY CODE MATCH ONLY
ALL MATCH
DATA NOT CHECKED

Stripe

For Stripe, the property will contain the following possible values:

Pass The CVC provided is correct.
Fail The CVC provided is incorrect.
Unavailable The customer's bank did not check the CVC provided.
Unchecked The CVC was provided but has not yet been checked.

Worldpay Online

For Worldpay Online, the property will contain one of the following:

ValueDescription
APPROVED The supplied CVC details matched the payment provider's records
NOT SENT TO ACQUIRER Problem with acquirer - possibly no CVC support
NO RESPONSE FROM ACQUIRERProblem with acquirer - possibly no CVC support
NOT CHECKED BY ACQUIRER The acquirer did not check the CVC details
NOT SUPPLIED BY SHOPPER Missing, or invalid CVC in the payment details prevented the CVC from being checked
FAILED The supplied CVC did not match the payment provider's records

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

Data Type

String

ResponseData Property (ECheck Component)

The entire response returned from the gateway processor.

Syntax

__property String ResponseData = { read=FResponseData };

Default Value

""

Remarks

The entire response returned from the gateway processor. This property contains the entire response returned from the gateway processor. You may use this to parse additional information that is not returned in the standard response properties.

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

Data Type

String

ResponseErrorCode Property (ECheck Component)

Additional error code returned by some gateways.

Syntax

__property String ResponseErrorCode = { read=FResponseErrorCode };

Default Value

""

Remarks

Additional error code returned by some gateways. If a gateway returns it, this property will contain an additional code that may explain why the transaction was declined. You may also wish to inspect ResponseErrorText for a human-readable description of this ResponseErrorCode.

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

Data Type

String

ResponseErrorText Property (ECheck Component)

Additional error description returned by some gateways.

Syntax

__property String ResponseErrorText = { read=FResponseErrorText };

Default Value

""

Remarks

Additional error description returned by some gateways. If a gateway returns it, this property will contain a human-readable description of the error which occurred (if any). You may also wish to inspect ResponseErrorCode for an accompanying code which may be parsed and used by your application.

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

Data Type

String

ResponseInvoiceNumber Property (ECheck Component)

Invoice number submitted in authorization request (if applicable).

Syntax

__property String ResponseInvoiceNumber = { read=FResponseInvoiceNumber };

Default Value

""

Remarks

Invoice number submitted in authorization request (if applicable). This property contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.

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

Data Type

String

ResponseProcessorCode Property (ECheck Component)

Response code from the underlying processor.

Syntax

__property String ResponseProcessorCode = { read=FResponseProcessorCode };

Default Value

""

Remarks

Response code from the underlying processor. Often times a Gateway will return a ResponseCode that indicates only whether the transaction is approved or declined. Many of these also include a secondary code that provides more details as to why the transaction was declined.

Note, for the PayFlowPro Gateway this property will contain a "1" if the transaction was a duplicate, a "-1" if duplicate checking service is unavailable, and will be blank for a successfully authorized transaction.

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

Data Type

String

ResponseText Property (ECheck Component)

Text information that describes each response code.

Syntax

__property String ResponseText = { read=FResponseText };

Default Value

""

Remarks

Text information that describes each response code. This property contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. A Gateway may translate the response according to the language indicated in the merchant account setup (if applicable).

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

Data Type

String

ResponseTransactionId Property (ECheck Component)

Contains the Visa Transaction Identifier or MasterCard Reference Number.

Syntax

__property String ResponseTransactionId = { read=FResponseTransactionId };

Default Value

""

Remarks

Contains the Visa Transaction Identifier or MasterCard Reference Number. This property contains a transaction identifier or reference number. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and used to submit a modification of this transaction at a later time (such as voiding the transaction or capturing an authorization-only transaction, if applicable).

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

Data Type

String

SpecialFieldCount Property (ECheck Component)

The number of records in the SpecialField arrays.

Syntax

__property int SpecialFieldCount = { read=FSpecialFieldCount, write=FSetSpecialFieldCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

SpecialFieldName Property (ECheck Component)

Name of special configuration property to submit in this transaction.

Syntax

__property String SpecialFieldName[int FieldIndex] = { read=FSpecialFieldName, write=FSetSpecialFieldName };

Default Value

""

Remarks

Name of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this component by submitting additional information to the gateway.

This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.

This property is not available at design time.

Data Type

String

SpecialFieldValue Property (ECheck Component)

Value of special configuration property to submit in this transaction.

Syntax

__property String SpecialFieldValue[int FieldIndex] = { read=FSpecialFieldValue, write=FSetSpecialFieldValue };

Default Value

""

Remarks

Value of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this component by submitting additional information to the gateway.

Note: This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (ECheck Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

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

Byte Array

SSLCertEncoded Property (ECheck Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

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

Byte Array

SSLCertStore Property (ECheck Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

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. PKCS12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (ECheck Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

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 (ECheck Component)

This is the type of certificate store for this certificate.

Syntax

__property TibpECheckSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };
enum TibpECheckSSLCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS11 interface.

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

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

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

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

Data Type

Integer

SSLCertSubject Property (ECheck Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a host name 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 (ECheck Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TibpECheckSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };
enum TibpECheckSSLProviders { sslpAutomatic=0, sslpPlatform=1, sslpInternal=2 };

Default Value

sslpAutomatic

Remarks

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

Possible values are:

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

Additional Notes

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

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (ECheck Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

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

Byte Array

TaxId Property (ECheck Component)

Company's Tax Id or a Customer's Social Security Number.

Syntax

__property String TaxId = { read=FTaxId, write=FSetTaxId };

Default Value

""

Remarks

This property contains a Company's Tax Id or a Customer's Social Security Number. In the absence of driver's license information, this property may be used by the gateway for fraud screening.

Data Type

String

TestMode Property (ECheck Component)

Turns test mode on and off for transactions sent to the current Gateway .

Syntax

__property bool TestMode = { read=FTestMode, write=FSetTestMode };

Default Value

false

Remarks

You can use this property to set a test mode flag that will be sent in an authorization request. Not all Gateways support test modes. If you set the TestMode property to True and the current Gateway does not support it, the component will raises an exception.

Data Type

Boolean

Timeout Property (ECheck Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the component will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

TransactionAmount Property (ECheck Component)

Purchase amount for an authorization or retry transaction. Not used for reversals.

Syntax

__property String TransactionAmount = { read=FTransactionAmount, write=FSetTransactionAmount };

Default Value

""

Remarks

This field contains the transaction amount to be authorized. Gateways may have differing requirements for how the TransactionAmount should be formatted, so refer to the ECheck Gateway Setup page for details on the gateway you are using.

Data Type

String

TransactionDesc Property (ECheck Component)

Description of goods purchased.

Syntax

__property String TransactionDesc = { read=FTransactionDesc, write=FSetTransactionDesc };

Default Value

""

Remarks

This field contains a description of the goods or services being purchased. Please see the "ICharge Gateway Setup and Required Properties" page to determine if this is a required or optional field for the gateway you are using.

Data Type

String

TransactionId Property (ECheck Component)

Merchant-generated transaction Id used for all transactions.

Syntax

__property String TransactionId = { read=FTransactionId, write=FSetTransactionId };

Default Value

""

Remarks

This property is used to send a merchant-generated transaction id to the Gateway, if the gateway supports that feature.

Data Type

String

AddSpecialField Method (ECheck Component)

Adds a special field name and the corresponding value.

Syntax

void __fastcall AddSpecialField(String Name, String Value);

Remarks

Please refer to the SpecialFieldName and SpecialFieldValue properties for more information on form variables and how they are managed.

Authorize Method (ECheck Component)

Initiates a check authorization transaction.

Syntax

void __fastcall Authorize();

Remarks

This method sends an authorization request to the specified Gateway.

Config Method (ECheck Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Credit Method (ECheck Component)

Credits a previous ACH transaction.

Syntax

void __fastcall Credit(String TransactionId, String CreditAmount);

Remarks

This method credits a previous ACH authorization. The TransactionId parameter indicates to the Gateway which transaction is to be voided, and should contain the ResponseTransactionId from the original transaction. The CreditAmount parameter is the value to be credited back to the customer, and can be all or part of the original TransactionAmount. The bank account indicated by BankRoutingNumber and BankAccountNumber must be identical to the original authorized transaction.

The following gateways support credit transactions:

Authorize.Net
ECX
Heartland
MPCS
Netbanx
Netbilling
PayTrace"Refund" transaction is performed.
Planet Payment
RTWare
TransNationalBankcard"Refund" transaction is performed.
TrustCommerce
USAePay
ACH FederalWhen a TransactionId is specified, a "Void" transaction will be performed. When "" (empty string) is specified for TransactionId, a "Credit" transaction will be performed.

DoEvents Method (ECheck Component)

Processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

GetResponseVar Method (ECheck Component)

Parses additional information out of the response.

Syntax

String __fastcall GetResponseVar(String Name);

Remarks

Due to the fact that this component supports so many gateways, only the most commonly used response variables are parsed into the Response properties. Any additional response information contained within the ResponseData may be retrieved with this GetResponseVar method. There are three formats for the ResponseData returned by the gateways this component supports: Name/value pairs, delimited list, or XML. The value you pass in the Name parameter changes based on these formats, as detailed below:

If the ResponseData property contains name/value pairs, pass the name in the Name parameter and this method will return the value. For instance, if ResponseData contains "ResponseCode=00&FraudScore=53&ApprovalCode=123456&...", calling GetResponseVar("FraudScore") will return "53".

However, if ResponseData contains a delimited list, pass the index of the field you wish to receive. For instance, if ResponseData contains "00|53|123456|...", calling GetResponseVar("1") will return "53".

Finally, if ResponseData contains XML, pass the xpath to the value you wish to receive. For instance, if ResponseData contains "<Response><Code>00</Code><FraudScore>53</FraudScore><ApprovalCode>123456</ApprovalCode></Response>", calling GetResponseVar("/Response/FraudScore") will return "53".

Interrupt Method (ECheck Component)

Interrupts the current action.

Syntax

void __fastcall Interrupt();

Remarks

This method interrupts any processing that the component is currently executing.

Reset Method (ECheck Component)

Clears all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

This method clears all properties to their default values and returns the component to its default state.

ResetSpecialFields Method (ECheck Component)

Resets all special fields to the default settings.

Syntax

void __fastcall ResetSpecialFields();

Remarks

This function resets all special gateway configuration fields to the default settings for the specified Gateway.

Please refer to the SpecialFieldName and SpecialFieldValue properties for more information on form variables and how they are managed.

VoidTransaction Method (ECheck Component)

Voids a previously authorized transaction.

Syntax

void __fastcall VoidTransaction(String TransactionId);

Remarks

This method voids a transaction that has been previously authorized, but which has not yet gone to settlement, or been "captured". The TransactionId parameter indicates to the Gateway which transaction is to be voided, and should contain the ResponseTransactionId from the original transaction.

Please see the gateway information in the table of contents to determine if your gateway supports Void transactions.

To cancel a transaction which has already been captured, use the Credit method.

The LinkPoint gateway requires you send the ResponseInvoiceNumber rather than the ResponseTransactionId. For the PSIGateXML Gateway, send the ResponseTransactionId as normal.

Error Event (ECheck Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibpECheckErrorEventParams;
typedef void __fastcall (__closure *TibpECheckErrorEvent)(System::TObject* Sender, TibpECheckErrorEventParams *e);
__property TibpECheckErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

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

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

SSLServerAuthentication Event (ECheck Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibpECheckSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibpECheckSSLServerAuthenticationEvent)(System::TObject* Sender, TibpECheckSSLServerAuthenticationEventParams *e);
__property TibpECheckSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

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

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

SSLStatus Event (ECheck Component)

Shows the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TibpECheckSSLStatusEventParams;
typedef void __fastcall (__closure *TibpECheckSSLStatusEvent)(System::TObject* Sender, TibpECheckSSLStatusEventParams *e);
__property TibpECheckSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Config Settings (ECheck Component)

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

eCheck Config Settings

AccountToken:   A token representing a bank account.

This configuration setting is used to specify a token representing a bank account when performing a transaction.

Note that this is only valid when the Gateway property is set to gwQBPayments.

AmountFormat:   Used to set the input format for TransactionAmount.

This configuration setting can be used to specify a single input format for the TransactionAmount property. When set to a value other than 0, the component will automatically convert the amount from the specified format to the format expected by the gateway. Valid values are:

Value Format
0 Unspecified (default)
1 Dollars (1.00)
2 Cents (100)

Note that this setting is only designed for use with currencies that have two digits after the decimal point, like US dollars.

AuthCode:   Authorization code from a previous transaction.

Some gateways require the merchant to include the ResponseApprovalCode from the original transaction in VoidTransaction transactions. This setting specifies the original approval code. The gateways which require this are listed below:

  • gwForte (36)

AuthNetOpaqueDescriptor:   An Authorize.Net opaque data descriptor.

This setting can be set to an Authorize.Net opaque data descriptor in order to use it in place of explicit card or bank account information. AuthNetOpaqueValue must also be set.

This setting is only valid with the gwAuthorizeNetXML and gwAuthorizeNetCIM gateways, it cannot be used with the gwAuthorizeNet gateway.

AuthNetOpaqueValue:   An Authorize.Net opaque data value.

This setting can be set to an Authorize.Net opaque data value in order to use it in place of explicit card or bank account information. AuthNetOpaqueDescriptor must also be set.

This setting is only valid with the gwAuthorizeNetXML and gwAuthorizeNetCIM gateways, it cannot be used with the gwAuthorizeNet gateway.

BASYSCheckInfoKey:   BASYS Gateway Check Info Key.

If BASYSProcessRecurringCheck set to True this must be set to the check info key assigned to the payment method when it was added to the system.

Note: BASYSCheckInfoKey can be obtained via the RecurringBilling component.

BASYSGovernmentCheck:   Determines whether the check is a government Check.

Determines whether the Check is a Government Check. By default this configuration setting is set to False.

BASYSProcessRecurringCheck:   Determines whether to process the transaction using Check Info Key.

Determines whether to process the transaction using customer's E-Check profile. By default this configuration setting is set to False. If set to True, BASYSCheckInfoKey and MerchantCode configuration settings must also be set. For instance: echeck.Config("MerchantCode=YourBASYSMerchantKey"); echeck.Config("BASYSProcessRecurringCheck=True"); echeck.Config("BASYSCheckInfoKey=YourBASYSCheckInfoKey"); echeck.TransactionAmount = "20.00"; echeck.Authorize();

BlueSnapEnterpriseUdfs:   User-Defined Fields (UDFs) to send with a BlueSnap Authorize request.

This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when calling Authorize: {"udf": [ { "udfValue": "aaa", "udfName": "ENT_UDF1" }, { "udfValue": "bbb", "udfName": "ENT_UDF2" } ]} Note: Content set using this setting will be used as the value of the transactionFraudInfo.enterpriseUdfs JSON field in the request body; it is not validated or manipulated first, it is used "as-is".

BlueSnapRetrieveTransaction:   Retrieves a BlueSnap transaction.

Setting this to an E-check transaction ID (or querying it with the TransactionId property set) will cause the component to retrieve the associated transaction and populate its fields accordingly. Please refer to the BlueSnap section of the "ECheck Gateway Setup and Required Properties" page for more information on how the component's fields map to BlueSnap's fields.

BlueSnapTransactionMetaData:   Transaction metadata to send with a BlueSnap Authorize request.

This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when calling Authorize: {"metaData": [ { "metaValue": 20, "metaKey": "stateTaxAmount", "metaDescription": "State Tax Amount" }, { "metaValue": 20, "metaKey": "cityTaxAmount", "metaDescription": "City Tax Amount" }, { "metaValue": 10, "metaKey": "shippingAmount", "metaDescription": "Shipping Amount" } ]} Note: Content set using this setting will be used as the value of the transactionMetaData JSON field in the request body; it is not validated or manipulated first, it is used "as-is".

CheckRoutingNumber:   Determines whether to perform a checksum test on the RoutingNumber.

When set to 'true', the component will perform a checksum test on the BankRoutingNumber when Authorize is called. This check helps identify errors within the specified BankRoutingNumber. Note that this check does not guarantee that the BankRoutingNumber is correct for the bank you wish to work with but does help in identifying mistyped numbers. The default value is 'false'.

CurrencyCode:   Currency code for the currency of the transaction.

This config is used to specify the currency code to be used in the transaction. Default values and codes vary based on the gateway. This config will be populated with the default value for the gateway when Gateway is set.

For more information on these currency code values, please refer to the ISO 4217 standard as well as the gateway specification.

CurrencyExponent:   Currency exponent to be used in conjunction with the Currency code of the transaction.

If not set, "2" is sent by default. Currently only supported in the Orbital gateway.

CyberSourceXMLEscape:   Determines whether to XML escape the CyberSource gateway request field values.

If this setting is set to "True", the request field values will be XML escaped prior to being sent to the CyberSource gateway. If this setting is set to "False" (default), the component does not perform any XML escaping and the values are sent exactly as specified. The default value is "False".

EscapeXML:   Automatically escape data within XML tags.

When set to true, this config will cause the component to automatically escape the XML data in the request. The default value is false. This is currently only supported in the Authorize.Net XML gateway.

GoEMerchantUseGatewayId:   Indicates whether to send a password or gateway Id for the GoEMerchant gateway.

By default, the Password property is sent as the "password" field in all requests. If the GoEMerchantUseGatewayId configuration setting is set to True, the component will instead treat the password as the "gateway_id" field in all requests.

HashSecret:   Security key used to generate a hash for gateways supporting such functionality.

Some gateways allow for the generation of a hash for added security. The following gateways support this config.

Authorize.Net: The newest version of the protocol includes an optional Hash Secret, which may be used to verify that a server response is actually from an Authorize.Net server. The hash secret is concatenated with the MerchantLogin, ResponseTransactionId, and TransactionAmount. This value is then hashed with the MD5 algorithm and compared to the value returned by the server. If they do not match, the component raises an exception. If the AIMHashSecret is left blank, this check will not be performed. The Server's Hash Secret may be set using the Authorize.Net online merchant interface, located at https://secure.authorize.net/.

USAePay: When specified, the component will compute an MD5 hash which is used to validate the transaction authenticity. The value specified should be the pin code set for a source.

HeartlandDeveloperId:   Optional DeveloperId field used by the Heartland gateway.

If HeartlandDeveloperId is set, the HeartlandVersionNumber should also be set. If set, this field must be exactly 6 characters in length. Used by gwHeartlandPortico.

HeartlandDeviceId:   DeviceId field required by the Heartland gateway.

This is issued by Heartland during registration. Used by gwHeartlandPortico.

HeartlandLicenseId:   LicenseId field required by the Heartland gateway.

This is issued by a Heartland Payment Systems Administrator during registration. Used by gwHeartlandPortico.

HeartlandSecretAPIKey:   Specifies the secret key to be used for authentication with Heartland.

If Heartland provides a secret key for use with their API, this property can be used to send it to the gateway. When this key is set, the HeartlandLicenseId, HeartlandSiteId, HeartlandDeviceId, MerchantLogin and MerchantPassword are not required, and will not be sent to the gateway.

HeartlandSiteId:   SiteId field required by the Heartland gateway.

This is issued by Heartland during registration. Used by gwHeartlandPortico.

HeartlandSiteTrace:   Optional transaction identifier for the Heartland gateway.

Heartland supplies an additional way to trace the transaction, beyond the InvoiceNumber and TransactionId. Used by gwHeartlandPortico.

HeartlandStoreId:   StoreId for the Heartland (62) gateway.

It is required for the Heartland (62) gateway.

HeartlandVersionNumber:   Optional VersionNumber field used by the Heartland gateway.

If HeartlandVersionNumber is set, the HeartlandDeveloperId should also be set. If set, this field must be exactly 4 characters in length. Used by gwHeartlandPortico.

MerchantAlias:   An additional merchant property used to specify an alias for the merchant.

The HSBC and PayFuse gateway both allow for a merchant alias to be specified (and in some cases it may be required). This field allows you to specify the alias.

MerchantCode:   Required field for the Litle gateway.

For the Litle gateway, this configuration setting should contain the Merchant Id supplied to you by Litle.

MerchantPartnersLast4Digits:   The last 4 digits of the account number for a transaction processed via the MerchantPartners gateway.

The last 4 digits of the account number are required to process transactions using a stored profile Id (via MerchantPartnersProfileId) for the MerchantPartners or WorldPay Link gateways.

MerchantPartnersProfileId:   The profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways.

This field is used to specify the Profile Id of a stored profile and is used to process a transaction instead of specifying the card data. A profile is created via the RecurringBilling component and the SubscriptionId response field is used to obtain the profile Id to be set in this field. MerchantPartnersLast4Digits is a required field when using a stored profile. Note this config is only applicable to Authorize and Credit transactions processed via the MerchantPartners or WorldPay Link gateways.

NetbanxAccountNumber:   Account Number for the Netbanx gateway.

This field is used to specify an account number for the Netbanx gateway which is used in addition to the MerchantLogin and MerchantPassword properties.

NetBillingVersion:   The Version to be sent in the User-Agent heading of a NetBilling gateway request.

The Version portion of the User-Agent HTTP header is required by NetBilling. The default value is '1'.

OrbitalConnectionPassword:   Orbital Connection Password field used by the Orbital gateway.

If OrbitalConnectionPassword is set, the OrbitalConnectionUsername should also be set. This field is case-sensitive.

OrbitalConnectionUsername:   Orbital Connection Username field used by the Orbital gateway.

If OrbitalConnectionUsername is set, the OrbitalConnectionPassword should also be set.

OrbitalCustomerProfileFromOrderInd:   Customer Profile Number generation Options for the Orbital gateway.

"A" Auto Generate the CustomerRefNum (CustomerId)
"S" Use CustomerRefNum (CustomerId) sent in the request.
"empty" Ignore this tag.

If not set, "empty" is sent by default.

OrbitalCustomerProfileOrderOverrideInd:   Indicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway.

"NO" No mapping to order data.
"OI" Pre-populate OrderId (InvoiceNumber) with the Customer Reference Number (CustomerId).
"OD" Pre-populate the Comments field (TransactionDesc) with the Customer Reference Number (CustomerId).
"OA" Pre-populate the OrderId (InvoiceNumber) and Comments (TransactionDesc) fields with the Customer Reference Number (CustomerId).

Note: This field is auto-populated to "NO" when OrbitalCustomerProfileFromOrderInd is set.

PayDirectConvenienceFee:   The total convenience fee charged when using the PayDirect gateway.

This field is used to specify the total convenience fee charged for the transaction when using the PayDirect gateway. This field is always required when using the PayDirect gateway. The sum of this field plus PayDirectMerchantAmount must always equal the value in TransactionAmount. If no values are set for either of these two configs, the component will set PayDirectMerchantAmount to the value specified in TransactionAmount and PayDirectConvenienceFee to "0.00".

PayDirectMerchantAmount:   The MerchantAmount used by the PayDirect gateway.

This field is used to specify the total amount of goods and services for the external client when using the PayDirect gateway. This field is always required when using the PayDirect gateway. The sum of this field plus PayDirectConvenienceFee must always equal the value in TransactionAmount. If no values are set for either of these two configs, the component will set PayDirectMerchantAmount to the value specified in TransactionAmount and PayDirectConvenienceFee to "0.00".

PayDirectSettleMerchantCode:   The Settle Merchant Code required for authorization when using the PayDirect gateway.

This field is used to set Settle Merchant Code assigned by Link2Gov for the Reconciliation of funds. This field is always required when using the PayDirect gateway.

PayerIP:   The IP address of the payer.

This config is used to specify the IP address of the payer, which is required by some gateways.

PayFlowProInquiry:   Submits an Inquiry transaction to the PayFlowPro gateway.

Set this config to the ResponseTransactionId from the transaction you wish to retrieve. You may also call PFPInquiry without setting it to anything. In this case the CustomerId property is required, and the PayFlow Pro gateway will return the most recent transaction for the specified Id.

PhoeniXGateCheckInfoKey:   PhoeniXGate Gateway Check Info Key.

If PhoeniXGateProcessRecurringCheck set to True this must be set to the check info key assigned to the payment method when it was added to the system.

Note: PhoeniXGateCheckInfoKey can be obtained via the RecurringBilling component.

PhoeniXGateGovernmentCheck:   Determines whether the check is a government Check.

Determines whether the Check is a Government Check. By default this configuration setting is set to False.

PhoeniXGateProcessRecurringCheck:   Determines whether to process the transaction using Check Info Key.

Determines whether to process the transaction using customer's E-Check profile. By default this configuration setting is set to False. If set to True, PhoeniXGateCheckInfoKey and MerchantCode configuration settings must also be set. For instance: echeck.Config("MerchantCode=YourPhoeniXGateMerchantKey"); echeck.Config("PhoeniXGateProcessRecurringCheck=True"); echeck.Config("PhoenixGateCheckInfoKey=YourPhoeniXGateCheckInfoKey"); echeck.TransactionAmount = "20.00"; echeck.Authorize();

RawRequest:   Returns the data that was sent to the gateway.

This may be queried after a call to any method that sends data to the gateway. This will return the request that was sent to the gateway which may be useful for troubleshooting purposes. For instance: echeck1.Authorize() MyString = echeck1.Config("RawRequest")

RawResponse:   Returns the data that was received from the gateway.

This may be queried after a call to any method that sends data to the gateway. This will return the response that was received to the gateway which may be useful for troubleshooting purposes. For instance: echeck1.Authorize() MyString = echeck1.Config("RawResponse")

RepayCheckInfoKey:   Repay Gateway Check Info Key.

If RepayProcessRecurringCheck set to True this must be set to the check info key assigned to the payment method when it was added to the system.

Note: RepayCheckInfoKey can be obtained via the RecurringBilling component.

RepayGovernmentCheck:   Determines whether the check is a government Check.

Determines whether the Check is a Government Check. By default this configuration setting is set to False.

RepayProcessRecurringCheck:   Determines whether to process the transaction using Check Info Key.

Determines whether to process the transaction using customer's E-Check profile. By default this configuration setting is set to False. If set to True, RepayCheckInfoKey and MerchantCode configuration settings must also be set. For instance: echeck.Config("MerchantCode=YourRepayMerchantKey"); echeck.Config("RepayProcessRecurringCheck=True"); echeck.Config("RepayCheckInfoKey=YourRepayCheckInfoKey"); echeck.TransactionAmount = "20.00"; echeck.Authorize();

TerminalId:   Terminal Id value sent in the transaction.

Many gateways allow/require an Id (terminal, developer, client, user, etc) sent in additional to the MerchantLogin and MerchantPassword. This config is supported for the following gateways: Adyen (required), BarClay (required), BluePay, HSBC (required), Orbital, PayFuse (required), and Planet Payment (required). For Orbital, this config is optional but if not specified a value of '001' will be sent. Terminal Id number for the BluePay gateways.

This is an optional config for USER_ID of the BluePay Gateway

TerminalId:   Terminal Id value sent in the transaction.

Many gateways allow/require an Id (terminal, developer, client, user, etc) sent in additional to the MerchantLogin and MerchantPassword. This config is supported for the following gateways: Adyen (required), BarClay (required), BluePay, HSBC (required), Orbital, PayFuse (required), and Planet Payment (required). For Orbital, this config is optional but if not specified a value of '001' will be sent. Terminal Id number for the BluePay gateways.

This is an optional config for USER_ID of the BluePay Gateway

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the component adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The component only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the component will accept compressed data. It then will uncompress the data it has received. The component will handle data compressed by both gzip and deflate compression algorithms.

When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component raises an exception if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the component.

If set to True, the URL passed to the component will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the component returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the component raises an exception.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the component raises an exception instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the component will perform a GET on the new location.

The default value is False. If set to True, the component will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the component.

This property specifies the HTTP version used by the component. Possible values are as follows:

  • "1.0"
  • "1.1" (default)
  • "2.0"
  • "3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to Connection: Keep-Alive. If False, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is False.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the component will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the component will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the component beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

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

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by components that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by components that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the component.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the component.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the component will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the component will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001.

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the component will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to True.

When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

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 component will use Timeout for establishing a connection and transmitting/receiving data.

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

This configuration setting is provided for use by components 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 components 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 component raises an exception.

Note: This setting is provided for use by components 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 components 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 components 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 component raises an exception.

Note: This setting is provided for use by components 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 component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

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

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 component initiate connections (or accept in the case of server components) only through that interface.

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

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

This must be set before a connection is attempted. It instructs the component 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 component will use IPv4 exclusively. When set to 1, the component will use IPv6 exclusively. To instruct the component 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 component will reuse the context if and only if the following criteria are met:

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

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 component will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the component will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The component 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 component raises an exception.

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

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

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

This setting specifies whether the component will use OCSP to check the validity of the server certificate. If set to 1 or 2, the component will first obtain the OCSP URL from the server certificate's OCSP extension. The component 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 component raises an exception.

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

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

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 component will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

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

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
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)
SSL2 12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

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

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

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

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

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

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

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite 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 ciphersuite strength.

Returns the strength of the ciphersuite 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 ciphersuite.

Returns the ciphersuite 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 component will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the component raises an exception.

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

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

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 component 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 component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

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 component 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 components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the component whether or not to use the system security libraries or an internal implementation.

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

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

This setting is set to false by default on all platforms.

Trappable Errors (ECheck Component)

ECheck Errors

159   Invalid form variable index (out of range).
501   Data field invalid length.
502   Data field invalid format.
503   Data field out of range.
510   No gateway specified.
511   Invalid data entered.
512   Truncated response.
513   Invalid response.
514   A Special Field is required for this transaction type.
542   Error computing MD5 hash

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

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

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the component is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
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).

Copyright (c) 2023 4D Payments Inc.
E-Payment Integrator 2022 C++ Builder Edition - Version 22.0 [Build 8593]