ICharge Configuration

This configuration setting is used to specify the sales channel the shopper gives their card details through and whether the shopper is a returning customer. Default value is 0.

Available values are:

This config is used to specify the type of request which will occur when the Sale method is called. By default it is set to Normal (0), in which case the component will send a normal transaction sale request.

The other options are used to instruct the component to send the appropriate type of request needed to query, create, update, or delete a customer vault record when Sale is called.

Possible values for this setting are:

• 0 - Normal (default)
• 1 - Add Customer Vault Record
• 2 - Update Customer Vault Record
• 3 - Delete Customer Vault Record
• 4 - Query Customer Vault Record

Please see the gateway setup information for American Payment Solutions for more details on how to use the ICharge component to work with customer vault records. Refer to American Payment Solutions' documentation for more information about the customer vault in general.

This configuration setting is used to specify the company in the billing information for the customer.

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

This config is used to specify the ID of a profile to be used to perform a transaction. A profile is used to identify the customer initiating the transaction. With the Authorize.NET CIM gateway, transactions are performed using profiles to access customer information stored on their Customer Information Manager (CIM) instead of sending raw customer data with the transaction. Therefore this property is required. Note: The RecurringBilling component can be used to manage profiles.

This config is used to specify the ID of a payment profile to be used to perform a transaction. A payment profile is tied to a AuthNetCIMProfileId and is used to identify the payment option to charge. With the Authorize.NET CIM gateway, transactions are performed using profiles to access customer information stored on their Customer Information Manager (CIM) instead of sending raw card and billing data with the transaction. Therefore this property is required. Note: The RecurringBilling component can be used to manage payment profiles.

This configuration setting is used to specify the credit card token to perform a Sale transaction.

Note that this is only valid when calling Sale method and the Gateway property is set to gwAuthorizeNetXML.

Whether to create a CIM profile for the customer during a Sale or AuthOnly transaction. By default this configuration setting is set to False. When set to True, the response for the profile creation will be returned in the AuthNetCIMProfileResponse configuration setting. For Example:

  icharge.Config("AuthNetCreateCIMProfile=True");

  icharge.Sale();

  Console.WriteLine(icharge.Config("AuthNetCIMProfileResponse"));

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

When requesting a CIM profile to be created by setting the AuthNetCreateCIMProfile configuration setting to True, this configuration setting will contain the response. For Example:

  icharge.Config("AuthNetCreateCIMProfile=True");

  icharge.Sale();

  Console.WriteLine(icharge.Config("AuthNetCIMProfileResponse"));

Note that this is read-only and only valid when Gateway property is set to gwAuthorizeNetXML.

This configuration setting is used to specify the value of the cryptogram received from the token provider. This configuration setting is required when AuthNetTokenizedCard configuration setting is set.

Note that this is only valid when calling Sale method and the Gateway property is set to gwAuthorizeNetXML.

This config is used to specify the ID of a shipping address profile to be used to perform a transaction. A shipping address profile is tied to a AuthNetCIMProfileId and is used to identify the shipping location of the item purchased in the current transaction. With the Authorize.NET CIM gateway, transactions are performed using profiles to access shipping information stored on their Customer Information Manager (CIM) instead of sending raw shipping data with the transaction. This property is optional. If an shipping address ID is not specified, shipping information will not be included with the transaction. Note: The RecurringBilling component can be used to manage shipping address profiles.

This configuration setting is used to specify the customer type to send during a request to the Authorize.NET XML gateway. Default value is 0.

Available values are:

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.

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.

This configuration setting is used to set the API passcode when using the passcode option for authentication with Bambora.

This configuration setting is required for some merchants when calling the Sale method, and must be set to the name of the card issuer. For example:

icharge.Config("BankName=Wells Fargo");

icharge.Sale();

By default (value of 'False'), all maintenance transactions (such as Capture, Refund, and VoidTransaction) will close the transaction after the operation is performed. When set to 'True', the operation will be performed and the transaction will be left open for further processing. This config works in conjunction with the following methods:

AuthOnly

Capture

Refund

VoidTransaction

By default (value of 'False'), the Refund method will send a partial or full refund which closes the transaction. When this setting is set to 'True', a partial refund transaction will be sent and the transaction will be left open for another potential refund.

Determines whether to process the transaction via customer's Credit Card profile. By default this configuration setting is set to False. If set to True, BASYSCardInfoKey and MerchantCode configuration settings must also be set. For instance:

icharge.Config("MerchantCode=YourBASYSMerchantKey");
icharge.Config("BASYSProcessRecurringCredit=True");
icharge.Config("BASYSCardInfoKey=YourBASYSCardInfoKey");
icharge.TransactionAmount = "1.00";

icharge.Sale();

If BASYSProcessRecurringCredit is set to True this must be set to the credit card profile id value assigned to the payment method when it was added to the system.

Note: BASYSCardInfoKey can be obtained via the RecurringBilling component.

Determines whether to process the transaction using a Credit Card Token provided by BASYS Gateway. By default this configuration setting is set to False. If set to True, BASYSTokenMode and BASYSToken must also be set. For Instance:

icharge.Config("BASYSProcessTokenCredit=True");
icharge.Config("BASYSToken=YourToken");
icharge.TransactionAmount = "1.00";

icharge.Sale();

Indicates the type of token that is being used for the transaction. If BASYSProcessTokenCredit is set to True this must be set to one of the following values.

Possible values:

If BASYSProcessTokenCredit is set to True, this must be set to the token value assigned to the payment method when it was added to the system.

Note: BASYSToken can be obtained via the RecurringBilling component.

If BASYSVoidMode is set to "0" (default), VoidTransaction sends a void to undo an unsettled transaction. If BASYSVoidMode is set to "1" (Reversal), this ensures the transaction is unsettled and also removes the authorization from the issuing bank.

Possible values:

This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when calling Sale or AuthOnly:

{"udf": [
  {
    "udfValue": "aaa",
    "udfName": "ENT_UDF1"
  },
  {
    "udfValue": "bbb",
    "udfName": "ENT_UDF2"
  }
]}

Each time this setting is queried, it will retrieve a new pfToken from BlueSnap. This token can then be passed to BlueSnap's hosted payment fields libraries, and then later passed in the transaction request using the special field pfToken or securityCodePfToken. Refer to BlueSnap's documentation for more information about hosted payment fields.

Setting this to a card 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 "ICharge Gateway Setup and Required Properties" page for more information on how the component's fields map to BlueSnap's fields.

This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when calling Sale or AuthOnly:

{"metaData": [
  {
    "metaValue": 20,
    "metaKey": "stateTaxAmount",
    "metaDescription": "State Tax Amount"
  },
  {
    "metaValue": 20,
    "metaKey": "cityTaxAmount",
    "metaDescription": "City Tax Amount"
  },
  {
    "metaValue": 10,
    "metaKey": "shippingAmount",
    "metaDescription": "Shipping Amount"
  }
]}

This configuration setting is used to specify the last 4 digits of the credit card in certain scenarios.

This configuration setting is used to specify the credit card token (sometimes called a "nonce") to perform a transaction.

Note that this is only valid when the Gateway property is set to gwGlobalOnePay, gwSquare, gwStripe, or gwQBPayments.

This config is used when sending 3D Secure data to the DataCash gateway. It indicates whether the cardholder was registered for 3D Secure and the PARes or VERes status. Available values are:

This config is used to specify whether an AuthOnly transaction should be treated as final. If the final settlement amount is not known, this config should be set to 'False' to indicate that the settlement amount will likely be changed prior to settlement. When set to 'True' or '' (empty string) (default value) the transaction will be treated as final. Note that with '' (empty string) the transaction will be treated as final unless the merchant configuration has been set up or there is a risk of reversal. MasterCard Europe and Maestro have created this mandate to improve the management of cardholder 'open to buy' limits.

The specified aggregate will be contained within the "ExtendedPolicy" element of the request.

The three available policies (elements) that can be specified are: "cv2_policy", "postcode_policy", and "address_policy". Each of these elements have five available attributes, "notprovided", "notchecked", "matched", "notmatched", "partialmatch", of which have the following available values: "accept" and "reject".

Below is a sample XML aggregate:

<cv2_policy notprovided="reject" notchecked="accept" matched="accept" notmatched="reject" partialmatch="reject"/> 
<postcode_policy notprovided="reject" notchecked="accept" matched="accept" notmatched="reject" partialmatch="accept"/> 
<address_policy notprovided="reject" notchecked="accept" matched="accept" notmatched="reject" partialmatch="accept"/>

This is an action config that will send a GetMethods request to the ExPay gateway. Method information returned in the response can be parsed via the GetResponseVar method or the X*** configuration settings.

This is an action config that will send a GetStatus request to the ExPay gateway. TransactionId or ExPayPaymentId is required (specifying both will result in an error). Status information returned in the response can be parsed via the GetResponseVar method or the X*** configuration settings.

This config is used to specify a payment Id to retrieve a transaction status for via ExPayGetStatus.

This config is used to specify the Id of the service (retrieved via a ExPayGetMethods call) and is required to perform an authorization via an AuthOnly call.

This is an action config which when called will send a create token request to the Global Payroll gateway. A successful response will contain the GlobalPayrollToken for the specified Number.

This field is used to retrieve or specify a token value. This field will be populated after a call to GlobalPayrollCreateToken This field should be specified prior to performing a transaction using a token value instead of Card.

This configuration setting is used to specify the source of a customer's data in an authorization request. For a "Card on File" request when the merchant is using data that they stored themselves, this value should be set to "Y". As per Merchant e-Solutions' documentation, valid values are:

This configuration setting is used to inform Merchant e-Solutions that the merchant will be storing a customer's credit card data. For the initial request, after which the customer's data will be stored, this should be set to true.

This configuration setting is used to inform Merchant e-Solutions that a transaction was initiated by the merchant and not by the cardholder.

This configuration setting is used to tell Merchant e-Solutions if a given transaction is Mail Order, Telephone Order, E-Commerce, or in person. As per Merchant e-Solutions' documentation, valid values are:

If this configuration setting contains a token during a request to MerchantESolutions, the token will be sent as part of the request. After a successful Sale, AuthOnly, or AVSOnly request with MerchantESolutionsTokenizeCard set, the token representing the card used in the request will be available by querying this configuration setting.

This configuration setting is used to request a tokenized card from Merchant e-Solutions. If it is set to true during a successful Sale, AuthOnly, or AVSOnly request, the response will include a token representing the card used in the transaction. Note that a token will not be requested if a token is already set in MerchantESolutionsToken.

This configuration setting is used when setting the Locale for a 3-party request with Metrobank. Controls the language that will appear on the payment page where the user is redirected.

This configuration setting is used when setting the URL where a user will be redirected after a 3-party request with Metrobank. There must be a server listening at that URL to receive the transaction response.

When sending a 3-party request to Metrobank, this configuration setting should be used to skip sending the request and output it directly to the RawRequest configuration setting instead. It can then be included in the POST request through which the user is redirected.

After sending a 3-party request to Metrobank and receiving the response, this configuration setting can be used to manually enter the response data into the ICharge component to parse the response.

Metrobank allows a merchant to void Purchase, Capture, or Refund transactions, but the request must indicate which type of transaction to void. Valid values are:

This configuration setting can be used to specify a customer profile to use during a request to the Orbital gateway. Additionally, after a request in which OrbitalCustomerProfileFromOrderInd is set it will contain the customer profile Id returned in the response.

When making a CDPT request with Orbital, this configuration setting can be used to specify the cryptogram corresponding to the CDPT token. The CDPT token itself should be supplied through the card's Number field.

The DPANIndicator is used to specify the type of authorization when making a CDPT request with Orbital. It should be set to "Y" for the original authorization and "S" for any subsequent related authorizations.

This config is used to retrieve the Transaction GUID returned in an authorization response for the Payvision gateway. This setting is also used to specify the Transaction GUID from a previous authorization, when performing a followup transaction (such as a Capture, Refund, or VoidTransaction).

Whether to generate a Token Reference Id based on the Credit Card information. This configuration setting can only be set when calling the Sale method.

By default this configuration setting is set to False. If set to True, a Token Reference Id will be returned in PayWiserTokenReferenceId configuration setting.

This field is used to specify a token value. This field should be specified prior to performing a transaction using a token value instead of Card.

Note: PayWiserCardToken can be obtained via the RecurringBilling component by setting the PayWiserRequestType configuration setting to 1.

This configuration setting is populated at the time the Token Reference Id is created by calling the Sale method and setting PayWiserTokenizeCard configuration setting to True. This field should be specified prior to performing a transaction using a Token Reference Id instead of Card.

This configuration setting is populated after calling the Sale method. The value returned by this configuration setting should be used when calling the Refund method.

Note: If the AuthOnly method is called, the Reserve Reference Id can be obtained via the Response property.

This configuration setting is populated after calling the Sale method.

Determines whether to process the transaction via E-Merchant Pay Acquiring Bank. When this configuration setting is set to True, ThreeDSuccessURL and ThreeDFailURL fields must also be sent using the AddSpecialField method. For example:

icharge.Config("PayWiserEMerchantPay=True");

icharge.AddSpecialField("ThreeDSuccessURL", "SuccessURL");
icharge.AddSpecialField("ThreeDFailURL", "FailURL");

icharge.AuthOnly();

By default this configuration setting is set to False.

Determines whether to process the transaction via customer's Credit Card profile. By default this configuration setting is set to False. If set to True, PhoeniXGateCardInfoKey and MerchantCode configuration settings must also be set. For instance:

icharge.Config("MerchantCode=YourPhoeniXGateMerchantKey");
icharge.Config("PhoeniXGateProcessRecurringCredit=True");
icharge.Config("PhoenixGateCardInfoKey=YourPhoeniXGateCardInfoKey");
icharge.TransactionAmount = "1.00";

icharge.Sale();

If PhoeniXGateProcessRecurringCredit is set to True this must be set to the credit card profile id value assigned to the payment method when it was added to the system.

Note: PhoeniXGateCardInfoKey can be obtained via the RecurringBilling component.

Determines whether to process the transaction using a Credit Card Token provided by PhoeniXGate Gateway. By default this configuration setting is set to False. If set to True, PhoeniXGateTokenMode and PhoeniXGateToken must also be set. For Instance:

icharge.Config("PhoeniXGateProcessTokenCredit=True");
icharge.Config("PhoeniXGateToken=YourToken");
icharge.TransactionAmount = "1.00";

icharge.Sale();

Indicates the type of token that is being used for the transaction. If PhoeniXGateProcessTokenCredit is set to True this must be set to one of the following values.

Possible values:

If PhoeniXGateProcessTokenCredit is set to True, this must be set to the token value assigned to the payment method when it was added to the system.

Note: PhoeniXGateToken can be obtained via the RecurringBilling component.

If PhoeniXGateVoidMode is set to "0" (default), VoidTransaction sends a void to undo an unsettled transaction. If PhoeniXGateVoidMode is set to "1" (Reversal), this ensures the transaction is unsettled and also removes the authorization from the issuing bank.

Possible values:

This configuration setting is used to hold a payment token for use with the Priority Payment Systems gateway. This setting is automatically populated after calling AuthOnly, Sale, or Credit for the Priority Payment Systems gateway.

For the Priority Payment Systems gateway, a payment token is used when calling Capture to specify what previously-authorized transaction should be captured. This setting must be set before calling Capture (the Capture method's TransactionId parameter is ignored).

(Note that Priority Payment Systems still uses a standard transaction Id for the VoidTransaction and Refund methods, only the Capture method uses a payment token instead.)

Determines whether to process the transaction via customer's Credit Card profile. By default this configuration setting is set to False. If set to True, RepayCardInfoKey and MerchantCode configuration settings must also be set. For instance:

icharge.Config("MerchantCode=YourRepayMerchantKey");
icharge.Config("RepayProcessRecurringCredit=True");
icharge.Config("RepayCardInfoKey=YourRepayCardInfoKey");
icharge.TransactionAmount = "1.00";

icharge.Sale();

If RepayProcessRecurringCredit is set to True this must be set to the credit card profile id value assigned to the payment method when it was added to the system.

Note: RepayCardInfoKey can be obtained via the RecurringBilling component.

Determines whether to process the transaction using a Credit Card Token provided by Repay Gateway. By default this configuration setting is set to False. If set to True, RepayTokenMode and RepayToken must also be set. For Instance:

icharge.Config("RepayProcessTokenCredit=True");
icharge.Config("RepayToken=YourToken");
icharge.TransactionAmount = "1.00";

icharge.Sale();

Indicates the type of token that is being used for the transaction. If RepayProcessTokenCredit is set to True this must be set to one of the following values.

Possible values:

If RepayProcessTokenCredit is set to True, this must be set to the token value assigned to the payment method when it was added to the system.

Note: RepayToken can be obtained via the RecurringBilling component.

If RepayVoidMode is set to "0" (default), VoidTransaction sends a void to undo an unsettled transaction. If RepayVoidMode is set to "1" (Reversal), this ensures the transaction is unsettled and also removes the authorization from the issuing bank.

Possible values:

This setting can be set to a JSON array like the following one in order to send one or more additional recipients data objects when calling Sale or AuthOnly:

[
  {
    "location_id": "057P5VYJ4A5X1",
    "description": "Application fees",
    "amount_money": {
      "amount": 20,
      "currency": "USD"
    },
    "receivable_id": "ISu5xwxJ5v0CMJTQq7RvqyMF"
  }
]

This configuration setting is used to specify the Id of a card-on-file associated with the Square customer profile specified by Id (which must be set, along with this configuration setting, to when making a Sale or AuthOnly request against a card-on-file).

Note that if a card nonce has been specified using the CardToken configuration setting, this setting's value is ignored and the card nonce is sent instead (regardless of whether Id is set).

Square requires that each Sale, AuthOnly, or Refund request have an idempotency key sent with it.

Idempotency key values should uniquely represent a real Sale, AuthOnly, or Refund. Any Sale, AuthOnly, or Refund request made using a duplicate idempotency key is ignored by Square.

Square requires that all transaction requests be made against one of the "location Ids" associated with a merchant's account.

This configuration setting must be set prior to making any requests when Gateway is set to gwSquare.

This configuration setting can be used to specify a Square Order Id to associate with a Sale or AuthOnly transaction request.

Note: Square will reject any transaction request that includes an Order Id if that transaction's amount does not match the associated Order's total amount.

This configuration setting is used to specify a Square Tender Id. It is populated after a successful Sale or AuthOnly request, and must be specified before making a Refund request.

Important: In addition to a Tender Id, Square transactions also have a Transaction Id. Be sure to persist both Ids after making a Sale or AuthOnly request, as both are required in order to make a Refund request!

A fee in cents that will be applied to the charge and transferred to the application owner's Stripe account. To use an application fee, the request must be made on behalf of another account, using StripeOnBehalfOf and StripeDestinationAccount configuration settings.

Id of an existing, connected stripe account. This configuration setting is required when an application fee will be transferred to the application owner's Stripe account via StripeApplicationFee configuration settings.

The amount to transfer to the destination account without creating an application fee. Cannot be combined with the StripeApplicationFee configuration setting. Must be equal to or lesser than the charge amount.

The Stripe account Id that funds are intended for. Automatically set if you are also setting the StripeApplicationFee configuration setting.

Whether the application fee should be refunded when refunding the charge. If a full charge refund is given, the full application fee will be refunded. Else, the application fee will be refunded with an amount proportional to the amount of the charge refunded. An application fee can only be refunded by the application that created the charge. This configuration setting is optional and can be set to either True or False.

Note that by default Stripe will not refund application fees.

Reason for the refund. Possible values are duplicate, fraudulent, and requested_by_customer.

Whether the transfer should be reversed when refunding the charge. The transfer will be reversed for the same amount being refunded (either the entire or partial amount). A transfer can only be reversed by the application that created the charge. This configuration setting is optional and can be set to either True or False.

Note that by default Stripe will not refund application fees.

The delivery service that shipped a physical product, such as FedEx, UPS, USPS, etc.

The tracking number for a physical product, obtained from the delivery service.

Identifies the transaction as part of a group.

When making a transaction with Stripe, this configuration setting tells Stripe which version of the API will be used. By default, Stripe will use the API version configured on the merchant's account. This setting should be the date of the version you want to use, such as "2019-09-09".

This configuration setting is required when calling the Sale method and must be set to the name of the card issuer. For example:

icharge.Config("VeritasBankName=Bank of China");

icharge.Sale();

This configuration setting must be set to the encryption key provided by the gateway. Encryption key used to encrypt credit card information.

This configuration setting must be set to the encryption key provided by the gateway.

Reason for voiding an authorized transaction for Veritas gateway. This configuration setting must be set when calling the VoidTransaction method.

Possible values:

This configuration setting must be set to the encryption key provided by the gateway. Encryption key used to encrypt credit card information.

This configuration setting must be set to the encryption key provided by the gateway.

Veritas token is provided by the gateway when activating the merchant account.

Worldpay Online token used in place of payment information when making a transaction.

This configuration setting, when set, will cause the component either generate, update, or delete a Worldpay Online token. Valid values are:

When AllowPartialAuths configuration setting is set to true and there are not enough funds to cover the full transaction amount set using the TransactionAmount property, Authorize.NET will return a Split Tender Id that can be later used, to link to the original partially authorized transaction, to charge the full amount, void, or capture.

When set to 'True', partial authorizations will be allowed and must be handled accordingly. A partial authorization occurs when a customer's available funds for a specific card can only meet a portion of the total TransactionAmount. Therefore a second means of payment must be used to pay for the remaining amount. When such a case occurs, the partially approved amount will be made available via ApprovedAmount. When set to 'False', if a customer's card does not have funds the available to account for the entire TransactionAmount the transaction will be declined. The default value is 'True'.

This setting specifies the Base-64 encoded data containing the encrypted payment data received from Apple. The encrypted payment data must be retrieved in a separate process by communicating with the Apple Passbook app. Once the encrypted payment data is received from Apple set this configuration setting, which takes the place of Card, and perform either an AuthOnly or Sale transaction to process the payment.

This setting is applicable to the following gateways:

• Authorize.NET (gwAuthorizeNet)
• BlueSnap (gwBlueSnap)

This setting is used to pass the 3D Secure authentication status on to the transaction server. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. Other values necessary for passing 3D Secure data include CAVV, XID and ECI. This setting is only valid for E-Commerce transactions. Applicable values are:

This setting takes a previous transaction's TransactionId. For any parameters that are not set, BluePay will use values from the referenced transaction.

When set to true, the component will update a prevous transaction when the Sale method is called. BluePayMasterId must be set to the TransactionId of the previous request, and the transaction can only be updated before it has been settled by BluePay.

This config allows you to specify the way in which the transaction took place. This config is applicable to the Barclay, HSBC, and PayFuse gateways.

Applicable values are:

This setting is used to pass 3D Secure CAVV data on to the transaction server. This field must be formatted as a 28-byte Base-64 encoded value. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. Other values necessary for passing 3D Secure data include XID and ECI. This setting is only valid for E-Commerce transactions.

This property will contain the CAVV response value to the authorization and will be populated along with Response. Values vary between gateways, so please consult gateway documentation for more information.

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.

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

This field is used to specify a dynamic descriptor (sometimes called a soft descriptor) for the transaction. Typically this value is used to specify transaction specific details which will be displayed on the customer's credit card statement.

The following gateways currently support this functionality: Heartland.

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.

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.

This configuration setting is used when there is an additional fee included in the transaction to specify the amount of that fee. This field is used by the Shift4 gateway.

Many gateways allow/require an Id (terminal, developer, client, user, etc) sent in addition to the MerchantLogin and MerchantPassword. This config is supported for the following gateways: Adyen (required), BarClay (required), BluePay, GlobalOnePay (required), Heartland, HSBC (required), Orbital, PayFuse (required), PaymentWorksuite, Planet Payment (required), SkipJack, and WorldPayXML (required). For Orbital, this config is optional but if not specified a value of '001' will be sent. For Heartland, this config is used for MasterCard's Card Accepter Terminal Id requirement.

This configuration setting is used when there is a tip included in the transaction to specify the amount of the tip. This field is used by the Shift4 gateway.

This configuration setting is used to specify an Id for the user, if one is required. Used by the Barclay, OGone, Metrobank, and Shift4 gateways. For the Barclay and OGone gateways, this configuration setting should contain the name of your application (API) user. For Shift4 or Metrobank, this is the clerk or terminal operator.

This setting is used to pass the 3D Secure TransactionId (XID) data on to the gateway. This setting must be formatted as a 20-byte plaintext value, or a 28-byte Base-64 encoded value. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. For example: Other settings necessary for passing 3D Secure data are CAVV and ECI. This setting is only valid for E-Commerce transactions.

This config is used to specify a request token for authorization update transactions (such as captures, credits, voids, and reversals). This is only applicable when using the Atos interface.

This config allows you to specify a customer Profile Id to process a transaction using the customer's information stored within CyberSource's systems (this is known as Payment Tokenization). When specified, the ProfileId will be sent instead of the card data (when performing an AuthOnly or Sale) and thus the stored card in the customer's profile will be charged. Additionally you can Credit a card on a customer's profile by specifying a Profile Id and a TransactionId of "" (empty string). Please note that the component does NOT support creating, modifying, or deleting customer profiles. These will need to be created using the RecurringBilling component or by other means such as within CyberSource's Business Center.

If CyberSourceVoidMode is set to "Void" (default), VoidTransaction sends a void transaction to cancel a Capture or Credit request. Note a transaction can only be voided if CyberSource has not already submitted the capture or credit request to the processor (this is usually done once a day). If CyberSourceVoidMode is set to "Reverse", a full authorization reversal transaction is sent to reverse a previous authorization (i.e. after performing an AuthOnly transaction). Note in a reversal, it is required that TransactionAmount be set to the full amount authorized (as you cannot partially reverse an authorization).

When returned in the response, this field will be populated with the current balance on the card used to process the transaction.

This field is used to specify the gift card transaction type you wish to perform. All gift card transactions are performed by setting the type via this config and calling the Sale method. When the transaction type is set to '0', the Sale, VoidTransaction and Refund methods can be called to perform their respective transactions. Note to process a gift card transaction, FDMSProcessGiftCard must be set to 'True'.

Applicable values are:

This config is used to specify the Key Id, obtained from FDMS, that corresponds to the HMAC Key (specified via HashSecret) and is sent within the Authorization header of the request.

When set to 'True', the current transaction will be run as a gift card transaction. The default value 'False', will perform a regular credit card transaction.

This config is used to both retrieve and specify a Transarmor Token for the First Data E4, Payeezy, and Bank Of America gateways. If your account is configured for Transarmor tokens, a token will be created by the server and returned via this config when performing a transaction using a Card data. Additionally, you can set this config to a previously retrieved token value and the token will be sent in the request rather than the Card data. This increases security as raw card data is no longer needed. Note when sending an FDMSTransArmorToken value, the CardType, ExpMonth, and ExpYear are required.

This config is used to specify the refund password provided to you by Global Iris. When a refund is performed, the component will use the specified password to generate and send a 'refundhash' in the request. This value is required when performing a Refund transaction.

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.

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

This is issued by Heartland during registration.

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

The Heartland gateway supports reversals of credit card transactions. To perform a reversal, TransactionAmount can be set and the VoidTransaction can be called. When performing a reversal, TransactionAmount must be set to the original authorized amount of the transaction you are performing the reversal on. This field should then be set to the settlement amount of the transaction (or the final authorized amount after the reversal is performed).

The ship day for the Heartland transaction. Valid values are 1 - 31.

The ship month for the Heartland transaction. Valid values are 1 - 12.

This is issued by Heartland during registration.

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

The field is used to specify the type of token that should be returned when using the Heartland gateway. By setting this field to a value other than 0 (None), a Token will be requested and returned in the response via HeartlandTokenValue (provided one can be generated). Please see the "ICharge Gateway Setup and Required Properties" page for more details about using tokenization, as there are special merchant account configurations required.

The available mapping values are:

This field is used to retrieve a Heartland Token value when using Heartland Tokenization (which is accomplished by setting HeartlandTokenMapping to a value greater than 0). A token replaces the card number in all subsequent transactions thus increasing security. This field can also be used to specify a previously retrieved token value. When set, the specified token value will be sent in the request instead of the card number.

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

This field is used to specify an XML aggregate for Custom Billing support within the Litle gateway. When specifying custom billing, you can use either the phone or url child.

Below is a sample XML aggregate for the phone child:

<phone>555-555-5555</phone>
<descriptor>Billing Descriptor</descriptor>

Below is a sample XML aggregate for the url child:

<url>retail.url</url>
<descriptor>www.retail.com</descriptor>

The last 4 digits of the card number are required to process transactions using a stored profile Id (via MerchantPartnersProfileId) for 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 Sale and Credit transactions processed via the MerchantPartners or WorldPay Link gateways.

This field is used to specify the Seed Id used to perform AES encryption. This field is provided by MIT and is required when performing AES encryption.

This field is used to specify the branch reference number for the MIT gateway (Required).

This field is used to specify the company reference number for the MIT gateway (Required).

This field is used to specify the country of operation for the MIT gateway (Required).

This field is used to specify the encryption algorithm to use for the MIT gateway. Encryption will only be performed if an encryption key is specified via MITEncryptionKey. Note when perform AES (1) encryption, you must also set MITAESSeedId.

Applicable values are:

This field is used to specify the encryption key for the MIT gateway. When set, the specified key will be used to perform the encryption specified via MITEncryptionAlgorithm.

When this field is set to 'True', the component will perform a recurring transaction request when Sale is called. The fields required for a Recurring charge transaction are the same as a Sale transaction. The default value is 'False'.

This field is used to specify the operation type for the MIT gateway (Required). This value will be provided to you by MIT.

The field is used to indicate whether to use the NVP API for either the gwMoneris or gwMonerisUSA gateway. When set to true, the NVP API will be used instead of the XML specification. Note that you must set Gateway to either gwMoneris or gwMonerisUSA prior to setting this field. Additionally, if you decide to use the NVP API, this field must be set directly after setting Gateway (as GatewayURL will be updated). Note: The Response Method of the DirectPost configuration must be set to "Displayed as key/value pairs on our server" in the merchant admin console when using the NVP API.

This field is used to override the default transaction type for the MyVirtualMerchant gateway. By default, the component will set the transaction type based on the method called. However this field can be set to override the default value and is particularly useful for creating recurring or installment billing transactions. Below is a list of some of the available transaction types. Note that these additional transaction types require special fields to be added via AddSpecialField. Please consult the Virtual Merchant specifications for details about the required fields.

• CCCOMPLETE
• CCADDINSTALL
• CCADDRECURRING
• CCINSTALLSALE
• CCRECURRINGSALE

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

This config is used to specify whether VoidTransaction should perform an authorization reversal or void transaction. When this config is set to 'True' and VoidTransaction is called, an authorization reversal transaction will be sent to reverse a previously authorized transaction. The default value is 'False' which sends a void transaction.

This field is used when performing a VoidTransaction to identify unique components of transactions adjusted more than one time. The default value ("NULL") should be submitted when voiding a transaction which has not been adjusted more than once or if the un-captured remainder of a split transaction (partial capture) should be voided. To void a specific partial capture, this field should be set to the value returned in the response for the partial capture. Note that this field will also be populated with the TxRefIdx value returned in a response.

This field is used to specify an amount to adjust a previous authorization when performing a VoidTransaction. Thus the specified amount will be voided (assuming that the amount is not greater than the transaction amount remaining) and the total amount minus the adjusted amount will be the new authorized amount. When a value is not specified, the full amount of will be voided.

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

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

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.

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

This field is used to specify a token value to perform additional authorizations (via Sale or AuthOnly) and Credits (via Credit) without sending card data again. For the Payflow Pro gateway, token values are the same as the TransactionId value returned from an authorization. Below is a code example of how this config can be used (note the code starts after the initial Sale or AuthOnly transaction has been performed):

ICharge.Config("PayFlowProToken=" + ICharge.Response.TransactionId);
ICharge.TransactionId = "2";
ICharge.TransactionAmount = "10.00";
ICharge.Sale();

This is an actionable config which when called will send an upload transaction to the Payflow Pro gateway. An upload transaction is used to store credit card information on the gateway server. Note that billing and shipping information can be saved as well. After a successful upload, TransactionId will contain the token value that corresponds to the credit card data stored. This token value can then be used to process transactions via PayFlowProToken.

This field allows you to specify whether Capture will send an update amount or a capture request. By default, this value is 'False', which sends a capture request to mark an AuthOnly transaction for capture. This particular function does not allow you to alter the amount but instead just marks the authorized amount (from the AuthOnly transaction) for capture. When this field is set to 'True', the Capture method will send an update amount request allowing you to alter the amount that will be captured. This method can be used after AuthOnly and Sale transactions.

The field is used to indicate whether to use the Freedom API for either the gwPayPoint and gwSECPay gateway. When set to true, the Freedom API will be used instead of the XML Hosted specification. Note that you must set Gateway to either gwPayPoint or gwSECPay prior to setting this field. Additionally, if you decide to use the Freedom API, this field must be set directly after setting Gateway (as GatewayURL will be updated).

This config is used to add Purchase Card (Level2 and Level3) Data to an existing sale transaction for the PayTrace gateway. The Level2Aggregate and Level3Aggregate fields can be set to specify the purchase card data you wish to add prior to calling this config. A TransactionId, from the response of the original sale, is required to be specified when calling this config; i.e.:

ICharge.Config("PayTraceAddPurchaseCardData=123456789");

This configuration setting can be set to indicate that a request is a recurring transaction. For a list of supported values for a gateway, please see the "ICharge Gateway Setup and Required Properties" page. This configuration setting is used by the QBPayments gateway.

When using the QBMS gateway, this setting specified whether a transaction is being sent from a mobile device ("True") or not ("False"). The default value is "False".

When using the QBPayments gateway, this setting specified whether a transaction is being sent from a mobile device ("True") or not ("False"). The default value is "False".

This is an action config which when called will send a create token request to the SagePay gateway. A successful response will contain the SagePayToken for the specified Number. Note: when using this config you must set the "VPSProtocol" SpecialFields to "3.00".

This is an action config which when called will send a remove token request to the SagePay gateway. The specified SagePayToken will be removed from the SagePay server. Note: when using this config you must set the "VPSProtocol" SpecialFields to "3.00".

This field allows you to specify whether to have SagePay generate a token and send it in the response. When set to 'True', a token will be returned in a Sale or AuthOnly response and can be accessed via SagePayToken. Note: when using this config you must set the "VPSProtocol" SpecialFields to "3.00". The default value is 'False'.

This field allows you to specify whether to store a token and on the SagePay server. This field must be set to 'True' to have the token remain on the server after use. Otherwise, if set to 'False', the Token will be used to perform the requested transaction and then deleted from the server. Note: when using this config you must set the "VPSProtocol" SpecialFields to "3.00". The default value is 'False'.

This field is used to retrieve or specify a token value. This field will be populated after a call to either SagePayCreateToken or SagePayRequestToken is set to 'True' and a Sale or AuthOnly request is performed. This field can be specified prior to calling SagePayRemoveToken or performing a transaction using a token value instead of Card.

This is an action config which when called will perform a Repeat transaction for the SagePay gateway. The 'TransactionId' from a previous authorization response, that you would like to repeat for the card associated with the transaction, must be specified as a parameter. For example, a Repeat transaction using a TransactionId of 123 would be: ICharge.Config("SagePayRepeat=123").

"RelatedSecurityKey" and "RelatedVendorTXCode" special fields are required for Repeats. These are parsed out of the original authorization response.

The SagePay gateway (formerly Protx) has two different void transaction types. If SagePayUseAbort is set to false (default), void transactions are sent with the VOID transaction type. If true, void transactions are sent with the ABORT transaction type. Aborts are used for voiding auth-only transactions, and voids are used for voiding sale/capture transactions.

The TransactionId from the original request must be passed as the parameter in the VoidTransaction method. In addition, the following Special Fields are required for both Abort and Void transactions:

This configuration setting is used to specify the AuthToken to include when making an Access Token Exchange request to the Shift4 gateway. An access token is required for any other interaction with the gateway.

This configuration setting is used to specify the Client Guid to include when making an Access Token Exchange request to the Shift4 gateway. An access token is required for any other interaction with the gateway.

This is an action config which when called will perform an Access Token Exchange request with the Shift4 gateway. Before calling this config, the MerchantLogin property and the Shift4InterfaceName, Shift4InterfaceVersion, Shift4AuthToken, and Shift4ClientGuid configuration settings should be set. MerchantPassword will be set to the access token if the request is successful. Note that an AuthToken can only be exchanged for an access token once, so be sure to save the result of the request for future use.

Shift4 requires you to identify the interface that you are using to communicate with the API (i.e. your application). This configuration setting is used to specify the name of the interface.

Shift4 requires you to identify the interface that you are using to communicate with the API (i.e. your application). This configuration setting is used to specify the version of the interface.

This field is used to specify whether you wish to perform a void or void:release transaction when VoidTransaction is called. When set to "True", the void:release transaction will be sent. The void:release transaction is the same as a void with the exception that the cardholders bank is notified immediately that they can release the funds. The regular void transaction, on the other hand, does not notify the cardholder bank until the batch closes. The default value is "False" (so a regular void transaction is sent).

This configuration setting can be used to set the company associated with the shipping address of the customer.

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

Certain gateways allow the request to be hashed as an additional authentication mechanism. This configuration setting controls which algorithm is used for hashing. Valid values are:

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, TransactionId, 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 throws 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/.

Bank of America: This value will be the HMAC Key generated for you by the gateway. This value is required and an exception will be thrown if not specified.

BarClay and Ogone: This value is optional and when specified 'SHASIGN' parameter will be computed and sent.

Bambora/Beanstream: If hash validation is required then set this to your hash key. HashAlgorithm will also need to be set accordingly.

GlobalOnePay: This value is required in all transactions. The value is unique to each terminal and can be set through the online interface at "https://testpayments.nuvei.com/merchant/selfcare/".

USAePay: This value is optional and when a 'Pin' value is specified, the 'UMhash' parameter will be computed and sent.

For the CardPointe gateway, this configuration setting is required, and should contain your Merchant Id.

For the Litle gateway, this configuration setting is required, and should contain your Merchant Id.

For the MIT gateway, this configuration setting is required, and should contain your Merchant Number (Contado).

For the Priority Payment Systems gateway, this configuration setting is required, and should contain your Merchant Id.

For the WorldPayXML gateway, this configuration setting is optional; it is only needed if you require that the "merchantCode" sent in the request be different from your MerchantLogin (e.g., when processing AMEX transactions, or when supporting multiple currencies).

When making a Merchant Initiated Transaction (MIT), this configuration setting should be set to true to indicate to the payment gateway that the transaction is merchant initiated. Used by the Orbital payment gateway.

When making a Merchant Initiated Transaction (MIT), this configuration setting can be used to specify the transaction Id of a previously successful authorization. Used by the Orbital and CyberSource payment gateways.

When making a Merchant Initiated Transaction (MIT), this configuration setting is used to specify the type or reason for the merchant initiated transaction. The possible values and formats for this field vary by gateway, so check the gateway's documentation for the associated values and their meanings.

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 config is used to specify the IP address of the payer, which is required by some gateways.

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

For the Stored Credentials framework, this configuration setting should be set to true to indicate that the merchant will be storing the customer's card information. Permission should be obtained from the customer prior to storing card data. This configuration setting is used by the CyberSource gateway.

For the Stored Credentials framework, this configuration setting should be set to true to indicate that the merchant is using stored card information. This configuration setting is used by the CyberSource gateway.

By default, when the Number or MagneticStripe 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 component 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 component only supports gzip and deflate decompression algorithms.

This setting enables HTTP compression for receiving data. When set to true, the component will accept compressed data. It will then 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 config. The default value for this header is "gzip, deflate".

This setting controls whether HTTP/2 connections are permitted to fallback to HTTP/1.1 when the server does not support HTTP/2. This setting is only applicable 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 throws an exception if the server does not support HTTP/2.

The default value is True.

This setting only applies when AuthScheme is set to Negotiate. If set to True the component will automatically use NTLM if the server does not support Negotiate authentication. Note that the server must indicate it supports NTLM authentication via the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. 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 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]".

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.

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

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 throws an exception.

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 component throws an exception instead.

Valid options are:

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

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.

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

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

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

HTTP/2 Notes

When using HTTP/2 only secure (TLS/SSL) connections are currently supported. 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 in order 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/2 is supported on all versions of Windows. If the Windows version is prior to Windows 8.1/Windows Server 2012 R2 the internal security implementation will be used. If the Windows version is Window 8.1/Windows Server 2012 R2 or later the system security libraries will be used by default.

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 via incremental indexing. 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.

If this setting contains a non-empty 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. An example is:

Sat, 29 Oct 2017 19:43:31 GMT.

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.

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

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

The value 2 (Verbose) additionally logs the content of the request and response including the headers and body for both the request and response.

The value 3 (Debug) logs additional debug information (if any).

This config should be set when the TransferredHeaders collection is to be populated when a Header event has been fired. This value represents the number of headers that are to be saved in the collection.

To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

This config should be set when populating the Cookies collection as a result of an HTTP request. This value represents the number of cookies that are to be saved in the collection .

To save all items to the collection , set this config to -1. If no items are wanted, set this to 0, which will not save any to the collection . The default for this config is -1, so all items will be included in the collection .

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

This 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" the component will fallback to using "1.1" automatically. This setting will indicate which was used.

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 component 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 User and Password are specified, this value is calculated using the algorithm specified by AuthScheme.

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

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

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

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

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

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

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.

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

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.

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

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.

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

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

This entry is for IPPort only and does not work for other components that descend from IPPort.

If this entry is set, the component acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.

RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.

The connection to the firewall is made by calling the Connect method.

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 throws an exception.

NOTE: This is the same as Password. This setting is provided for use by components 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 Port. This setting is provided for use by components that do not directly expose Firewall properties.

The appropriate values are as follows:

NOTE: This is the same as FirewallType. This setting is provided for use by components 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 component throws an exception.

NOTE: This is the same as User. This setting is provided for use by components 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.

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

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

This 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

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 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:

When authenticating with NTLM this setting specifies whether NTLM V2 is used. By default this value is False and NTLM V1 will be used. Set this to True to use NTLM V2.

This setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. In order to keep streams open after the transfer of data, set this to False. the default value is True.

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.

This setting specifies the paths on disk to CA certificate files when using Mono on Unix/Linux. It is not applicable in any other circumstances.

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

The default value is:

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

When the UseInternalSecurityAPI configuration setting is True, 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 UseInternalSecurityAPI is 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 setting.

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

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

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.

Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider.

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.

The special value "Internal" picks the internal SSL implementation. This does not rely on any system libraries. This is equivalent to setting UseInternalSecurityAPI to True.

Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed except to a value of "Internal".

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 in Java or when the provider is OpenSSL.

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

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 UseInternalSecurityAPI is False (default):

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");

• 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

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");

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

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

• TLS_AES_128_GCM_SHA256
• TLS_AES_256_GCM_SHA384
• TLS_CHACHA20_POLY1305_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True 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 throws an exception.

The format of this value is a comma separated list of hash-signature combinations. For instance:

IPPort.Config("UseInternalSecurityAPI=true");
IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2
IPPort.Config("TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-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.

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 UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

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

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_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

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

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

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_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_secp256r1" (default)
• "ecdhe_secp384r1" (default)
• "ecdhe_secp521r1" (default)
• "ffdhe_2048" (default)
• "ffdhe_3072" (default)
• "ffdhe_4096" (default)
• "ffdhe_6144" (default)
• "ffdhe_8192" (default)

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

• "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)

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

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GuiAvailable to false will ensure that the component does not attempt to process external events.

If set to True, when the component creates a thread the thread's IsBackground property will be explicitly set to True. By default this setting is False.

By default the component will use the system security libraries to perform cryptographic functions. When set to False calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the component to use the internal implementation instead of using the system's security API.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set the product's system DLL is no longer required as a reference, as all unmanaged code is stored in that file.