This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

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

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform-dependent.

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

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

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

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform-dependent.

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

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

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

This is the type of certificate store for this certificate.

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

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

This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.

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

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

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

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

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

This field contains comma-separated lists of alternative subject names for the certificate.

This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This field contains the text description of UsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

• Digital Signatures
• Key Authentication
• Key Encryption
• Data Encryption
• Key Agreement
• Certificate Signing
• Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:

Please see the Usage field for a text representation of UsageFlags.

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

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

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

Available values:

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

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

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

Available values:

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

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

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

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

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

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

component.Customer = new EPCustomer(); component.Customer.Address = "123"; component.AddSpecialField("avs_street_name, "Nowhere Ln");

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

This field allows you to get or set an XML aggregate built from all of the fields from this type. "EPCustomer" is the root element, and the names of the fields create the tags under the root. For instance: <EPCustomer> <Address>123 Nowhere Ln.</Address> <Address2>Apt 3B.</Address2> <City>Beverly Hills</City> ... </EPCustomer>

Customer's city. This field is used as part of the Address Verification Service (AVS) and contains the customer's city as it appears on their monthly statement. Other AVS fields include Address, State, and Zip.

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

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

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

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

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

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

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

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

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

Customer's state. This field is used as part of the Address Verification Service (AVS) and contains the two character postal abbreviation of the customer's state as it appears on their monthly statement. Other AVS fields include Address, City, and Zip.

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

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

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

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

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

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

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

Adyen

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

American Payment Solutions

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

Barclay

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

BlueSnap

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

The possible values for each result character are:

HSBC

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

PayTrace / PayTraceJSON

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

QBMS

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

DataCash

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

Stripe

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

Worldpay

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

The possible values for each result character are:

Worldpay Online

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

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

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

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

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

HSBC

For HSBC, the field will contain:

Adyen

For Adyen, the field will contain:

Barclay

For Barclay, the field will contain:

BlueSnap

For BlueSnap, the field will contain:

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

DataCash

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

Stripe

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

Worldpay Online

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

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

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

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

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

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

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

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

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

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

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

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

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

This field is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.

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

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

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

For security reasons, setting this field will clear the values of User and Password.

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

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

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

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

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

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

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

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

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

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

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

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

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

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

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

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

• gwForte (36)

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.

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

Note: BASYSCheckInfoKey can be obtained via the RecurringBilling component.

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

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

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

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

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

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

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

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.

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.

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

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

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

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

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

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

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

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

It is required for the Heartland (62) gateway.

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

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.

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

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

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

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

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.

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

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

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.

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

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.

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

Note: PhoeniXGateCheckInfoKey can be obtained via the RecurringBilling component.

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

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

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

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

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

Note: RepayCheckInfoKey can be obtained via the RecurringBilling component.

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

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

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

This is an optional config for USER_ID of the BluePay Gateway

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

This is an optional config for USER_ID of the BluePay Gateway

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

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

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

The default value is True.

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

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

The default value is True.

This configuration setting applies only when AuthScheme is set to Negotiate. If set to True, the component will automatically use New Technology LAN Manager (NTLM) if the server does not support Negotiate authentication. Note: The server must indicate that it supports NTLM authentication through the WWW-Authenticate header for the fallback from Negotiate to NTLM to take place. The default value is False.

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

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

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

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

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

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

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

The default value is False.

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

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

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

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

Following are the valid options:

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

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

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

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

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

HTTP/2 Notes

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

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

HTTP/2 is supported on all versions of Windows. If the Windows version is an earlier version than 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/3 Notes

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

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

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

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

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

The default value for KeepAlive is False.

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.

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

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

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

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

This configuration setting 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 configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

This configuration setting 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 configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The default value is False and the hostname will always be used exactly as specified.

This configuration setting specifies whether the platform's deflate-algorithm implementation is used to decompress responses that use compression. If set to True (default), the platform implementation is used. If set to False, an internal implementation is used.

When using this configuration setting, 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 in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

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

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

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.

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 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 configuration 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 setting is provided for use by components that do not directly expose Firewall properties.

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

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 setting is provided for use by components that do not directly expose Firewall properties.

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

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

The appropriate values are as follows:

Note: 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 setting is provided for use by components that do not directly expose Firewall properties.

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

Note: This value is not applicable in macOS.

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

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

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