RecurringBilling Configuration

This configuration setting can be used to set the company associated with the customer when a Payment Profile is created.

This config is used to specify the request type to send for the Authorize.NET CIM gateway and is used in conjunction with the API methods to perform various actions.

The available request types are:

This config is used to retrieve or set the ID of a Payment Profile. This config will be populated after a Payment Profile is created or when one is retrieved (via a GetSubscriptionStatus call). Additionally when AuthNetCIMRequestType is set to '1' (Payment Profile), the Payment Profile ID must be set, via this config, when performing the following operations: UpdateSubscription, CancelSubscription, or GetSubscriptionStatus.

This config is populated after a GetSubscriptionStatus call for a Profile (AuthNetCIMRequestType set to '0') and contains the total number of Payment Profiles assigned to the specified customer profile. This is to be used in conjunction with AuthNetCIMPaymentProfileIndex.

This is an actionable config that parses the Payment Profile contained within the response at the specified index. This is a 1-based index and is to be used in conjunction with AuthNetCIMPaymentProfileCount. Index values less than 1 and greater than AuthNetCIMPaymentProfileCount will cause an exception to be thrown. When this config is set, the Payment Profile at the specified index will be parsed and the Card, ECheckBank, and Customer properties will be populated based on the data in the response.

This config is used to retrieve or set the ID of a Shipping Address. This config will be populated after a Shipping Address is created or when one is retrieved (via a GetSubscriptionStatus call). Additionally when AuthNetCIMRequestType is set to '2' (Shipping Address), the Shipping Address ID must be set, via this config, when performing the following operations: UpdateSubscription, CancelSubscription, or GetSubscriptionStatus.

This config is populated after a GetSubscriptionStatus call for a Profile (AuthNetCIMRequestType set to '0') and contains the total number of Shipping Addresses assigned to the specified customer profile. This is to be used in conjunction with AuthNetCIMShippingAddressIndex.

This is an actionable config that parses the Shipping Address contained within the response at the specified index. This is a 1-based index and is to be used in conjunction with AuthNetCIMShippingAddressCount. Index values less than 1 and greater than AuthNetCIMShippingAddressCount will cause an exception to be thrown. When this config is set, the Shipping Address at the specified index will be parsed and the ShippingInfo properties will be populated based on the data in the response.

This config is used to specify the 'username' value to authenticate with the Beanstream gateway and is only applicable when calling CreateSubscription.

When set to "True" (default value), in the case of a manually entered card, the transaction will be processed with the card being identified as present. When set to "False", the transaction will be processed as a 'Card Not Present' transaction.

This config is currently applicable to the Heartland gateway.

This config is used to specify the type of credit card being used in a retail transaction. The type will be computed by the component based on the Card data but this value can be specified to override any computed values.

The available card types are:

When set to 'true', the component will perform a checksum test on the BankRoutingNumber when CreateSubscription 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'.

This configuration setting contains the Check Number. This is valid only for PhoeniXGate and Repay gateways.

This config contains the Customer's Company Name associated with the billing address.

This field is used to set a password for the customer. This field has different uses depending on the gateway. Please see the gateway specifications for further information as to how this field is used. This config is applicable to the PlugNPay gateway.

This field is used to set a username for the customer. This field has different uses depending on the gateway. Please see the gateway specifications for further information as to how this field is used.

This field is used to specify the date format to be used for the various date properties: PaymentScheduleStartDate, PaymentScheduleEndDate, SubscriptionDetailsStartDate, SubscriptionDetailsEndDate, SubscriptionDetailsNextPaymentDate, and SubscriptionDetailsLastPaymentDate. The date must be specified and will be displayed in the format specified. The default format is: "MM/dd/yyyy".

Applicable format values are:

This config is used to specify the Customer Id for the Eway account and is used for authentication.

This setting may be used to specify the date that the PaymentScheduleInitialAmount should be charged. The date is based on the format specified via DateFormat and must be the same as, or before PaymentScheduleStartDate. This setting is optional.

This setting defines the transaction type for the Eway gateway and is applicable when calling CreateSubscription, UpdateSubscription, GetSubscriptionStatus, and CancelSubscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:

This setting is used when sending a registration request for the FirstDataPayPoint gateway. For the registration to be stored in First Data's system, the customer must be asked for approval of the registration process and this setting must be set to 'True'. If 'False' (default value) is set, the registration process will fail.

This setting defines the transaction type for the FirstDataPayPoint gateway and is applicable when calling CreateSubscription, UpdateSubscription, GetSubscriptionStatus, and CancelSubscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:

This settings specifies the transaction type for the GoToBilling gateway and is applicable when calling CreateSubscription, UpdateSubscription, GetSubscriptionStatus, and CancelSubscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:

This config 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 config may be used by the gateway for fraud screening.

This config contains the customer's driver's license number and may be used by the gateway for fraud screening.

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

This specifies the method used to identify the customer when performing a retail transaction.

Possible values are:

This setting specifies an XML aggregate when creating or updating a subscription for the Litle gateway. Specifically this allows you to create, update, or delete Discounts and AddOns. Please see the Litle XML Reference Guide for further information regarding these XML fields. This setting is only used when LitleTransactionType is set to '1' and CreateSubscription or UpdateSubscription is called.

This setting specifies the transaction type for the Litle gateway and is applicable when calling CreateSubscription, UpdateSubscription, and CancelSubscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:

This setting specifies a trial frequency for the Litle gateway. It is used in conjunction with PaymentSchedule. Possible values are:

• "MONTH" (Trial interval of one month)
• "DAY" (Trial interval of one day).

The last 4 digits of the account number are required to perform UpdateSubscription, CancelSubscription, and GetSubscriptionStatus methods for the MerchantPartners or the WorldPay Link gateways.

This setting is used to specify the encrypted reader type used to read and encrypt a swiped card. The specified value is sent in the request and is used by the gateway to decrypt the card data so the transaction can be processed.

Valid Values:

This config is used to specify the transaction type to send for the Payment WorkSuite gateway and is used in conjunction with the API methods to perform various actions.

The available transaction types are:

This setting is used to specify the transaction type for the PayTrace gateway and is applicable when calling CreateSubscription, UpdateSubscription, and CancelSubscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:

This configuration setting is used to specify the request type for the PayWiser gateway.

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:

The default value is 0 (Customer Profile). Option 0, 1 and 2 are only valid when CreateSubscription method is called. Option 3 and 4 are only valid when calling CancelSubscription method.

This configuration setting can be used to specify a custom plan pattern for recurring payments. If set, this configuration setting will override all the fields previously set using the PaymentSchedule property.

Structure of PayWiserPlanPattern and PayWiserRetryPattern:

For daily recurrence:

Example: D20160301ZZZZZZZZ001002003

Explanation: Starting from 1.3.2016, there will be payment every three days and there will be 10 repetitions. If you wish to make a payment every day, pattern would be D20160301ZZZZZZZZ001002001.

For weekly recurrence:

Example: W20160301ZZZZZZZZ001002NYNNNNN001

Explanation: Starting from 1.3.2016, there will be payment every Monday and there will be 10 repetitions. If you wish to make a payment every 2 weeks, pattern would be W20160301ZZZZZZZZ001002NYNNNNN002.

For For monthly recurrence:

Example: M20160301ZZZZZZZZ00100229ZZ000001

Explanation: Starting from 1.3.2016, there will be payment on every 22nd of the month and there will be 10 repetitions. If you wish to make a payment every 2 months with 10 repetitions, pattern would be M20160301ZZZZZZZZ00100229ZZ000002.

For For Yearly recurrence:

Example: Y20160301ZZZZZZZZ0010022203ZZZ000

Explanation: Starting from 1.3.2016, there will be payment on every March 22nd and there will be 10 repetitions. If you wish to make a payment every first day of December with 10 repetitions, pattern would be Y20160301ZZZZZZZZ0010120000AAL000.

This configuration setting can be used to specify a custom retry pattern for recurring payments in case of a failed payment. Please follow the instructions described in PayWiserPlanPattern for formatting the retry pattern.

Note if this configuration setting is set, MaxRetryCount filed must be also set using the AddSpecialField method. For example:

recurring.AddSpecialField("MaxRetryCount", "1");
recurring.Config("PayWiserRetryPattern=W20160901ZZZZZZZZ010002NNYYYYN002");

This configuration setting can be used to specify the hour of the day, when each payment will be executed. This configuration setting must be set when automatically creating the recurring schedule using the PaymentSchedule property.

This configuration setting is populated at the time the Token is created by calling CreateSubscription and setting PayWiserRequestType configuration setting to 1. This configuration setting must be set to the generated card token when calling CreateSubscription and setting PayWiserRequestType configuration setting to 2.

This configuration setting is populated at the time the Token is created by calling CreateSubscription and setting PayWiserRequestType configuration setting to 1.

This configuration setting is populated at the time the recurring plan is created by calling CreateSubscription and setting PayWiserRequestType configuration setting to 0 (default). This configuration setting must be set to the generated plan id when calling CancelSubscription and setting PayWiserRequestType configuration setting to 3.

This configuration setting is used to specify the request type for the PhoeniXGate gateway.

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:

The default value is 0 (Customer Profile).

Customer status at the time the customer profile is created and PhoeniXGateRequestType is set to 0 (Default).

Possible values are:

The default value is 0 (Active).

When PhoeniXGateRequestType is set to 3 (Recurring Payment) a payment type must be set to one of the following values.

Possible values are:

The default value is 0 (Credit Card).

When PhoeniXGateRequestType is set to 5 (Get Token) a token type must be set to one of the following values.

Possible values are:

The default value is 0 (Gateway Format).

This configuration setting is populated at the time the Token is created by calling CreateSubscription and setting PhoeniXGateRequestType configuration setting to 5.

This configuration setting is populated at the time the customer profile is created by calling CreateSubscription and setting PhoeniXGateRequestType configuration setting to 0. This configuration setting must be set when the PhoeniXGateRequestType configuration setting is set to 1, 2, 3, 4 and 5 and when calling UpdateSubscription, and CancelSubscription.

This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting PhoeniXGateRequestType configuration setting to 1. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 1 and when calling UpdateSubscription, and CancelSubscription.

This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting PhoeniXGateRequestType configuration setting to 2. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 2 and when calling UpdateSubscription, and CancelSubscription.

This configuration setting is populated at the time the payment schedule is added to the system by calling CreateSubscription and setting PhoeniXGateRequestType configuration setting to 3. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 3 and when calling UpdateSubscription, and CancelSubscription.

Unique identifier assigned to the contract by the merchant at the time the payment schedule is created. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 3 and when calling CreateSubscription.

Identifies the next time the contract will come due in MM/DD/YYYY format. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 3 and when calling CreateSubscription, and UpdateSubscription.

Note: If only the billing date is to be updated, it is better to set the PhoeniXGateRequestType configuration setting to 4 and set the PhoeniXGateNumberOfDays configuration setting to the number of days to be added to the billing date.

This configuration setting must be set to the number of days to be added to the next billing date when PhoeniXGateRequestType configuration setting is set to 4 and when calling and UpdateSubscription. PhoeniXGateContractKey must also be set to the corresponding contract key.

This configuration setting is used to specify the request type for the Repay gateway.

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:

The default value is 0 (Customer Profile).

Customer status at the time the customer profile is created and RepayRequestType is set to 0 (Default).

Possible values are:

The default value is 0 (Active).

When RepayRequestType is set to 3 (Recurring Payment) a payment type must be set to one of the following values.

Possible values are:

The default value is 0 (Credit Card).

When RepayRequestType is set to 5 (Get Token) a token type must be set to one of the following values.

Possible values are:

The default value is 0 (Gateway Format).

This configuration setting is populated at the time the Token is created by calling CreateSubscription and setting RepayRequestType configuration setting to 5.

This configuration setting is populated at the time the customer profile is created by calling CreateSubscription and setting RepayRequestType configuration setting to 0. This configuration setting must be set when the RepayRequestType configuration setting is set to 1, 2, 3, 4 and 5 and when calling UpdateSubscription, and CancelSubscription.

This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting RepayRequestType configuration setting to 1. This configuration setting must be set when RepayRequestType configuration setting is set to 1 and when calling UpdateSubscription, and CancelSubscription.

This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting RepayRequestType configuration setting to 2. This configuration setting must be set when RepayRequestType configuration setting is set to 2 and when calling UpdateSubscription, and CancelSubscription.

This configuration setting is populated at the time the payment schedule is added to the system by calling CreateSubscription and setting RepayRequestType configuration setting to 3. This configuration setting must be set when RepayRequestType configuration setting is set to 3 and when calling UpdateSubscription, and CancelSubscription.

Unique identifier assigned to the contract by the merchant at the time the payment schedule is created. This configuration setting must be set when RepayRequestType configuration setting is set to 3 and when calling CreateSubscription.

Identifies the next time the contract will come due in MM/DD/YYYY format. This configuration setting must be set when RepayRequestType configuration setting is set to 3 and when calling CreateSubscription, and UpdateSubscription.

Note: If only the billing date is to be updated, it is better to set the RepayRequestType configuration setting to 4 and set the RepayNumberOfDays configuration setting to the number of days to be added to the billing date.

This configuration setting must be set to the number of days to be added to the next billing date when RepayRequestType configuration setting is set to 4 and when calling and UpdateSubscription. RepayContractKey must also be set to the corresponding contract key.

This configuration setting is used to specify the date of the month that a recurring payment should occur when PaymentScheduleFrequency is set to "Monthly", or "Yearly".

This configuration setting is used to specify the day of the week that a recurring payment should occur when PaymentScheduleFrequency is set to "Weekly", "Monthly", or "Yearly". This setting is made up of two fields, a value and a type. The value and type are separated with a colon (:), i.e. [value]:[type]. Possible values are:

Possible types are:

This setting is used to specify the month that a recurring payment should occur when PaymentScheduleFrequency is set to "Yearly". This is used in conjunction with PlanetPaymentFrequencyDay. Possible values are:

This setting specifies the transaction type for the QBMS gateway and is applicable when calling CreateSubscription, UpdateSubscription, and CancelSubscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:

This setting may be set after calling GetSubscriptionStatus and will populate SubscriptionDetails with the details located at the specified status index. Valid values are 1 through the value returned by ResponseText.

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.

This config is used to specify the capability of the terminal being used in a retail transaction.

The available values for the CyberSource gateway are (If not specified, the component will set the value to either '2' or '3' based on the specified CardEntryDataSource.):

The available values for the Litle gateway are (If not specified, the component will set the value to 'magstripe'.):

This config is used to specify the terminal (device) type being used in a retail transaction.

The available values for Chase, First Data, LinkPoint, and YourPay are (required):

This field is used for the gateways the support International card types. Supported gateways include: Adyen, Barclay, CyberSource, FastTransact, HSBC, NetBanx, NetBilling, Orbital, PayFuse, PaymentExpress, PayPoint, PlugNPay, SagePay, SECPay, and WorldPayXML. Switch, Solo, and some Maestro cards have a 1 or 2 digit Issue number printed on the front of the card, directly following the card number. If that issue number is present, it should be set with this config setting.

If there is a Start Date present on the card, set the month here and the year in CardStartYear.

If there is a Start Date on present on the card, set the year here and the month in CardStartMonth.

This field is used to specify the total convenience fee charged for the transaction. This field is applicable to the FirstDataPayPoint and Litle / Vantiv gateway.

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 class does not perform any XML escaping and the values are sent exactly as specified. The default value is "False".

This contains a 1-character transaction indicator identifying the type of transaction being authorized. Supported values vary between gateways, so please consult gateway documentation for more information. Note: Other values necessary for passing 3D Secure data are XID and CAVV. This setting is only valid for E-Commerce transactions.

For the Litle gateway, this configuration setting should contain the Merchant Id supplied to you by Litle. For the MIT gateway, this configuration setting should contain the Merchant Number (Contado) supplied to you by MIT. For the WorldPayXML gateway, if the MerchantCode is empty, the MerchantLogin will be sent in the request. If you require the merchantCode sent in the request to be different from your MerchantLogin (eg, for processing AMEX transactions, or when supporting multiple currencies), you can use this configuration setting for that purpose.

This field is used to specify your MyVirtualMerchant user Id which is required (along with MerchantLogin and MerchantPassword) as part of the user authentication.

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

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

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

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

This field is used to specify the client code that is assigned by 3DSI. This code uniquely identifies your organization for the purpose of accessing and authenticating to the Payment WorkSuite.

This field is used to specify the location code that uniquely identifies a specific location that is associated with the merchant identified by the specified PaymentWorkSuiteMerchantCode.

This field is used to specify the merchant code that uniquely identifies a specific merchant within the Payment WorkSuite.

This value is assigned by PayTrace and is used for validation and tracking purposes. The default value is: "90000035NSFT".

This may be queried after a call to any method that sends data to the gateway. This will return the request data that was sent to the gateway which may be useful for troubleshooting purposes. For instance:

component.Sale()
MyString = component.Config("RawRequest")

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:

component.Sale()
MyString = component.Config("RawResponse")

By default, when the CardNumber or CardMagneticStripe property is set, the value is validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and MagneticStripe data will be sent as specified with no parsing or validations performed. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways (eg: FastTransact) to send ascii data in the Number field. This may be accomplished by setting ValidateCardNumber to false. However, please note that in doing so, automatic calculation of the CardType may be affected, and the card number may not be able to be verified.

XPath implements a subset of the XML and JSON XPath specification, allowing you to point to specific elements in the XML or JSON documents. The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location. The following are possible values for an element accessor:

When XPath is set to a valid path, XElement points to the name of the element, with XChildren and XText providing other properties of the element.

Example (Setting XPath for XML)

Example (Setting XPath for JSON)

The current element is specified in the XPath configuration option.

This configuration option is read-only.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

The number of child attributes of the current element. The XChildren configuration options will be indexed from 0 to XChildrenCount-1.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

Provides the name of the x'th child element of the current element.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

Provides the inner text of the x'th child element of the current element.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

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

This is the same as the AllowHTTPCompression property. This setting is exposed here for use by classs that inherit from HTTP.

By default the class does not allow redirects to the same URL to avoid redirect loops. In some cases the server may intentionally redirect the client back to the same URL. In that case this setting may be set to True to allow the redirect to be followed. The default value is False.

This setting determines whether data is 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 only applicable when LocalFile is set. The default value is False.

If the Authorization property contains a non-empty 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 class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

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

Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/or compressed. This returns the same value as the Transfer event, by BytesTransferred.

The default value is false. If set to true the URL passed to the class will be URL encoded.

This option determines what happens when the server issues a redirect. Normally, the class 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 class fails with an error.

Note that 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 could potentially change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server and port are different than 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 class fails with an error instead.

Valid options are:

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

The default value is false. If set to true the class will perform a GET on the new location. Otherwise it will use the same HTTP method again.

Possible values include "1.0", and "1.1". The default is "1.1".

This is the same as the IfModifiedSince property. This setting is exposed here for use by classs that inherit from HTTP.

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 that not all server support persistent connections. You may also 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.

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

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

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

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

This configuration option is useful for extending the functionality of the class beyond what is provided.

Similar to the Authorization config, but for proxy authorization. If this config contains a non-empty 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.

This is the same as ProxyAuthScheme. This setting is provided for use by classs that do not directly expose Proxy properties.

This is the same as ProxyPassword. This setting is provided for use by classs that do not directly expose Proxy properties.

This is the same as ProxyPort. This setting is provided for use by classs that do not directly expose Proxy properties.

This is the same as ProxyServer. This setting is provided for use by classs that do not directly expose Proxy properties.

This is the same as ProxyUser. This setting is provided for use by classs that do not directly expose Proxy properties.

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

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

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

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

If True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments where direct access to sockets is limited or not allowed (as in the Google AppEngine for instance).

Note: This setting is only applicable to Mac/iOS editions.

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

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

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.

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

This is the same as FirewallAutoDetect. This setting is provided for use by classs that do not directly expose Firewall properties.

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 is the same as FirewallHost. This setting is provided for use by classs that do not directly expose Firewall properties.

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

NOTE: This is the same as FirewallPassword. This setting is provided for use by classs that do not directly expose Firewall properties.

Note that the FirewallPort is set automatically when FirewallType is set to a valid value.

NOTE: This is the same as FirewallPort. This setting is provided for use by classs that do not directly expose Firewall properties.

The appropriate values are as follows:

NOTE: This is the same as FirewallFirewallType. This setting is provided for use by classs that do not directly expose Firewall properties.

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

NOTE: This is the same as FirewallUser. This setting is provided for use by classs that do not directly expose Firewall properties.

When set, TCPKeepAlive will automatically be set to true. By default the operating system will determine the time a connection is idle before a 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.

Note: This value is not applicable in Java.

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 acknowledgement is received from the remote host the keep-alive packet will be re-sent. This 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 Java or MAC.

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 acknowledgement is received from the remote host the keep-alive packet will be re-sent. This setting specifies the number of times that the keep-alive packets will be re-sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform, and isn't supported in Mac OS or FreeBSD.

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

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

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

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data is 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 (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action.

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

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

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

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

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

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

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

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

MaxLineLength 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. The maximum value is 65536 bytes.

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

If set to a positive value, this setting defines the length of data records to be received. The class will accumulate data until RecordLength is reached and only then fire the DataIn event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.

The default value is 0, meaning this setting is not used.

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.

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

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.

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.

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.

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:

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

TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Change this setting to use security providers other than the system default.

Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application.

The special value "*" (default) picks the default SSL provider defined in the system.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed.

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

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

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.

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.

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

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.

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.

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

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

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

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

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

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

The default code page is the Active Code Page (0).

The following is a list of valid code page identifiers:

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