E-Payment Integrator 2020 Qt Edition

Questions / Feedback?

RecurringBilling Configuration

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

RecurringBilling Configuration Settings

3DSECI:   Electronic Commerce Indicator.

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 3DSXID and 3DSCAVV. This setting is only valid for E-Commerce transactions.

AmountFormat:   Used to set the input format for TransactionAmount.

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

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

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

AuthNetCIMGuestProfile:   Specifies whether a profile is a guest profile or a normal profile.

If this configuration setting is set to True when creating a customer profile (default False), the profile will be created as a guest profile. A guest profile will be deleted automatically after 90 days of inactivity. This setting can also be checked after getting the status of a customer profile to tell if it is a guest profile.

AuthNetCIMMaskedCardNumber:   The masked card number returned for the payment profile at the specified index.

This config holds the masked card number that is stored in the payment profile selected by AuthNetCIMPaymentProfileIndex.

When updating a payment profile, this masked card number will be re-submitted if real card information is not specified, which prevents Authorize.Net from changing the card information on file. This makes it possible to update just the billing information associated with a payment profile without affecting the stored card information. This configuration setting can also be used when updating a subscription with the Authorize.NET gateway.

AuthNetCIMPaymentProfileCount:   The number of Payment Profiles assigned to a customer profile within the Authorize.NET CIM gateway.

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

AuthNetCIMPaymentProfileId:   The Payment Profile ID assigned by Authorize.NET CIM gateway.

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

AuthNetCIMPaymentProfileIndex:   Parses the Payment Profile contained at the specified index within a GetSusbcriptionStatus response.

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

AuthNetCIMRequestType:   The request type to send for the Authorize.NET CIM gateway.

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

The available request types are:

Value Description
0 (default) Profile - Used to perform a profile activity
1 Payment Profile - Used to perform a payment profile activity (card/bank and billing info) which is linked to a profile.
2 Shipping Address - Used to perform a shipping address activity which is linked to a profile.

AuthNetCIMShippingAddressCount:   The number of Shipping Addresses assigned to a customer profile within the Authorize.NET CIM gateway.

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

AuthNetCIMShippingAddressId:   The Shipping Address ID assigned by Authorize.NET CIM gateway.

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

AuthNetCIMShippingAddressIndex:   Parses the Shipping Address contained at the specified index within a GetSusbcriptionStatus response.

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

AuthNetGetSubscriptionDetails:   Specifies whether a call to GetSubscriptionStatus will return the details of the subscription or just the status.

When getting the status of a subscription in the Authorize.Net gateway, if this configuration setting is set to "False" (default) GetSubScriptionStatus will only return the Status of the subscription in SubscriptionDetails. When set to "True", calling GetSubscriptionStatus will return more details about the subscription and populate other fields in SubscriptionDetails, as well as AuthNetCIMMaskedCardNumber, AuthNetCIMPaymentProfileId, AuthNetShipToCompany, and AuthNetCIMShippingAddressId.

AuthNetOpaqueDescriptor:   An Authorize.Net opaque data descriptor.

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

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

AuthNetOpaqueValue:   An Authorize.Net opaque data value.

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

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

AuthNetShipToCompany:   The name of the company associated with the customer's shipping address.

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

BamboraUsername:   The Username used for authentication with the Bambora gateway.

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

BASYSCardInfoKey:   BASYS Gateway Credit Card Info Key.

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

BASYSCheckInfoKey:   BASYS Gateway Check Info Key.

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

BASYSContractID:   BASYS Gateway Contract ID.

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

BASYSContractKey:   BASYS Gateway Contract Key.

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

BASYSCustomerKey:   BASYS Gateway Customer Key.

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

BASYSCustomerStatus:   Indicates the Customer Status.

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

Possible values are:

Value Description
0 Active
1 Inactive
2 Pending
3 Clsoed

The default value is 0 (Active).

BASYSNextBillingDate:   BASYS Gateway Next Billing Date.

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

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

BASYSNumberOfDays:   Number of days to be added to the next billing date.

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

BASYSPaymentType:   Indicates the Payment Type.

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

Possible values are:

Value Description
0 Credit Card
1 Check/ACH

The default value is 0 (Credit Card).

BASYSRequestType:   The request type for the BASYS gateway.

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

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:

Value Description
0 Customer Profile: Used to create a customer profile. This is the first step towards successfully storing and initiating recurring payments.
1 Credit Card Info: Used to to store a credit card number. The Customer Key must be specified via BASYSCustomerKey configuration setting.
2 Check Info: Used to store a checking account number. The Customer Key must be specified via BASYSCustomerKey configuration setting.
3 Recurring Payment: Used to create a payment schedule. The Customer Key must be specified via BASYSCustomerKey configuration setting.
4 Next Bill Date: Used to update the next billing date in the event that a payment was declined and a contract suspended. The Customer Key and Contract Key must be specified via BASYSCustomerKey, and BASYSContractKey configuration settings.
5 Get Token: Used to generate a Token based on the Credit Card information. The Customer Key must be specified via BASYSCustomerKey configuration setting.

The default value is 0 (Customer Profile).

BASYSToken:   BASYS Gateway Token Value.

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

BASYSTokenMode:   Indicates the Token Type.

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

Possible values are:

Value Description
0 Default (BASYS Gateway Default Format).
1 Card Format.

The default value is 0 (Gateway Format).

BlueSnapCardCount:   How many card payment sources the last retrieved vaulted shopper has.

When BlueSnapRequestType is set to 2, this setting can be queried to determine how many card payment sources the last retrieved vaulted shopper profile has.

Important: Be sure to call GetSubscriptionStatus after setting BlueSnapRequestType (or after calling UpdateSubscription with it already set) in order to ensure that you have retrieved the most recent data!

BlueSnapCardIndex:   Determines which card payment source the class's fields are populated for currently.

When BlueSnapRequestType is set to 2, this setting can be used to specify which of the last retrieved vaulted shopper's card payment sources the class should populate its fields with. Valid values are -1 to BlueSnapCardCount-1.

To add a new card payment source, set this to -1, which will cause the class to reset the populated fields to their default values.

To update an existing card payment source (be it the card expiration date or its billing information), first set this to the desired card's index, modify the fields you wish to change, and set the full card number and security code, and then call UpdateSubscription. (The update request will fail if you do not set the full card number and security code first, they are not returned when the vaulted shopper is retrieved.)

Note that the BlueSnap API makes no guarantee about the order of the card payment sources when it returns a vaulted shopper response. As such, it is important that you never assume that you know which card is at a particular index right after you call GetSubscriptionStatus or UpdateSubscription.

Important: Be sure to call GetSubscriptionStatus after setting BlueSnapRequestType (or after calling UpdateSubscription with it already set) in order to ensure that you have retrieved the most recent data!

BlueSnapEnterpriseUdfs:   User-Defined Fields (UDFs) to send when updating a BlueSnap vaulted shopper.

This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when updating a vaulted shopper profile's payment source:

{"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".
BlueSnapGetToken:   Retrieves a new hosted payment fields token (pfToken) from BlueSnap.

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 vaulted shopper request using the special field pfToken. Refer to BlueSnap's documentation for more information about hosted payment fields.

BlueSnapRequestType:   The request type for the BlueSnap gateway.

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

When you set the value of this setting, the class resets the properties, special fields, and configuration settings it uses to map to BlueSnap vaulted shopper fields. Only the following retain their values: Gateway, MerchantLogin, MerchantPassword, TestMode, BlueSnapVaultedShopperId, and Response fields (other than CVVResult and AVSResult, which are reset).

It is expected that you will call GetSubscriptionStatus to retrieve and populate the class with the latest vaulted shopper details after setting this (unless you plan to create a new vaulted shopper, or keep in mind that any fields not sent in an update request may be cleared by BlueSnap).

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:

ValueDescription
0 Create vaulted shopper with basic information
1 Retrieve/Update basic vaulted shopper information
2 Retrieve/Add/Update a Card payment source
3 Retrieve/Update the ECheck payment source

The default value is 0, which is the only valid request type when calling the CreateSubscription.

The other request types require you to set the Vaulted Shopper ID via the BlueSnapVaultedShopperId configuration setting, after which you may use the GetSubscriptionStatus and UpdateSubscription methods to retrieve and add/update vaulted shopper data (note that any method parameters are ignored).

Note that all basic information is automatically retrieved and then re-sent when adding/updating any payment source in order to prevent BlueSnap from clearing those fields.

BlueSnapVaultedShopperId:   BlueSnap gateway vaulted shopper ID.

This configuration setting must be set to a valid vaulted shopper ID when updating a BlueSnap vaulted shopper. After creating a new vaulted shopper, it will contain the newly created vaulted shopper's ID. See BlueSnapRequestType for more information.

CardIssueNumber:   Special Issue Number used for Switch and Solo cards.

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.

CardLast4Digits:   The last 4 digits of a credit card.

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

CardPresent:   Specifies whether the card is present during the transaction.

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

This config is currently applicable to the Heartland gateway.

CardStartMonth:   Used for some international cards.

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

CardStartYear:   Used for some international cards.

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

CardToken:   The credit card token.

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 gwNuvei or gwSquare.

CardType:   Type of credit card being used in this transaction.

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

The available card types are:

Value Description
0 Invalid or unknown prefix, card type not known
1 Visa or Delta Card
2 MasterCard
3 American Express Card
4 Discover Card
5 Diners Club or Carte Blanche Card
6 JCB Card
7 Visa Electron Card (runs as a Visa for most gateways)
8 Maestro Card
10 Laser Card (Ireland)

CheckNumber:   Check Number.

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

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

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

CompanyName:   The Customer's Company Name.

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

ConvenienceFee:   The total convenience fee charged for a transaction.

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.

CustomerPassword:   The Customer's Password.

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

CustomerUsername:   The Customer's Username.

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

CyberSourceDeleteSubscription:   Whether subscriptions should be deleted when CancelSubscription is called.

This setting determines whether CyberSource subscriptions will be deleted (True) or just cancelled (False) when the CancelSubscription method is called.

By default this setting is False; calling CancelSubscription will cause a subscription to be cancelled, but it will remain in the CyberSource Business Center.

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

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

DateFormat:   The format of the date properties.

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

Applicable format values are:

Format Description
'Y' or 'y' Year
'M' Month
'd' Day Of Month

EscapeXML:   Automatically escape data within XML tags.

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

EwayCustomerId:   The Customer Id used to authenticate with the Eway gateway.

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

EwayInitialDate:   The date of the initial payment for the Eway gateway.

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

EwayTransactionType:   The Transaction Type for the Eway gateway.

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

Value Description
0 Rebill Event: Used to create a defined payment plan for a customer. The customer Id must be specified via TransactionId.
1 Customer: Used to create a customer. A customer must be created before creating a recurring transaction (Rebill Event).

FirstDataPayPointAgreedToTerms:   Specifies whether the customer has approved the registration process and agreed to the terms for the FirstDataPayPoint gateway.

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

FirstDataPayPointTransactionType:   The Transaction Type for the FirstDataPayPoint gateway.

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

Value Description
0 Recurring Transaction: Used to create a defined payment plan for a generated registration. The Registration Id must be specified via TransactionId.
1 Registration: Used to create a registration for card, billing, and shipping information. A registration must be created before creating a recurring transaction.

HashAlgorithm:   Algorithm used for hashing.

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:

Value Algorithm
0 MD5 (default)
1 SHA-1

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

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

Authorize.Net: The newest version of the protocol includes an optional Hash Secret, which may be used to verify that a server response is actually from an Authorize.Net server. The hash secret is concatenated with the MerchantLogin, ResponseTransactionId, and TransactionAmount. This value is then hashed with the MD5 algorithm and compared to the value returned by the server. If they do not match, the class fails with an error. 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 Ingenico: 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.

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

LicenseDOB:   Customer's Date of Birth as indicated on his drivers license.

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

LicenseNumber:   Customer's driver's license number.

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

LicenseState:   State in which customer's driver's license was issued.

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

LitleCardholderId:   Describes the method used to identify the cardholder at the point of sale for the Litle gateway.

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

Possible values are:

Value Description
"signature" (default) Customer signature obtained.
"pin" PIN Number.
"nopin" Unattended terminal - no PIN pad.
"directmarket" Mail, telephone, or online.

LitleSubscriptionAggregate:   Used to specify an XML aggregate for Subscription Create and Update transactions within the Litle gateway.

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

LitleTransactionType:   The Transaction Type for the Litle gateway.

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

Value Description
0 Plan: Used to create a defined payment plan. This is applicable when calling CreateSubscription or UpdateSubscription.
1 Subscription: Used to enroll a customer in recurring billing based on a specified payment plan. This is applicable when calling CreateSubscription, UpdateSubscription, or CancelSubscription.

LitleTrialFrequency:   Used to specify a trial frequency for the Litle gateway.

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

  • "MONTH" (Trial interval of one month)
  • "DAY" (Trial interval of one day).
MerchantCode:   A gateway-supplied merchant number, code, or Id.

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

MerchantPartnersLast4Digits:   The last 4 digits of the account number for a transaction processed via the MerchantPartners or WorldPay Link gateways.

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

MerchantPartnersReaderType:   The reader type used to read and encrypt a swiped card for the MerchantPartners or WorldPay Link gateways.

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

Valid Values:

Value Description
1 Magtek Udynamo
2 Magtek IPAD
3 All IDTech Devices
4 Specific Ingenico Devices

MITFlag:   For the MIT framework - Used to indicate that a transaction is merchant initiated.

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.

MITPriorTransId:   For the MIT framework - Used to specify a prior transaction id to be referenced in a merchant initiated transaction.

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.

MITType:   For the MIT framework - Indicates the type of transaction being requested in a Merchant-Initiated Transaction (MIT).

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.

MyVirtualMerchantUserId:   The MyVirtualMerchant user Id as configured on VirtualMerchant.

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

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

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

NuveiPermittedTerminals:   A list of the terminals permitted to use a Nuvei secure card.

This config is used when creating a secure card for Nuvei to list the terminals that will be allowed to use the created card. This should be a comma-separated list of terminal Ids, i.e. "11111,22222,33333".

OmniFundTransactionType:   The Transaction Type for the OmniFund gateway.

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

Value Description
0 Recurring Transaction: Used to create or modify a recurring transaction. The customer Id must be specified via CustomerId, and the account Id must be specified via TransactionId.
1 Customer: Used to create, modify, or retrieve information about a customer. A customer must be created before creating an account or recurring transaction.
2 Account: Used to create, modify, or retrieve information about an account. The customer Id must be specified via CustomerId. An account must be created before creating a recurring transaction.

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

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

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

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

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

"A" Auto Generate the CustomerRefNum (CustomerId)
"S" Use CustomerRefNum (CustomerId) sent in the request.
"0" Use OrderID (InvoiceNumber) sent in the request.
"D" Use Comments (TransactionDesc) sent in the request.

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

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

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

PayerIP:   The IP address of the payer.

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

PaymentWorkSuiteClientCode:   The 3DSI assigned client code sent in a request to the PaymentWorksuite gateway.

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.

PaymentWorkSuiteLocationCode:   The 3DSI assigned location code sent in a request to the PaymentWorksuite gateway.

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.

PaymentWorkSuiteMerchantCode:   The 3DSI assigned merchant code sent in a request to the PaymentWorksuite gateway.

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

PaymentWorkSuiteTransactionType:   The transaction type to send for the Payment WorkSuite gateway.

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

The available transaction types are:

Value Description
0 (default) Stored Credit Card - Used to perform a stored credit card operations.
1 Customer - Used to perform customer operations.

PayTraceIntegratorId:   Used to specify the Integrator Id value assigned by the PayTrace gateway.

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

PayTraceTransactionType:   The Transaction Type for the PayTrace gateway.

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

Value Description
0 Customer: Used to create a customer. A customer must be created before creating a recurring payment.
1 Recurring Payment: Used to create a recurring payment for a customer. The customer Id must be specified via TransactionId.

PayWiserCardToken:   PayWiser Gateway Card Token Value.

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

PayWiserPaymentHour:   Payment hour.

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

PayWiserPlanPattern:   PayWiser plan pattern for creating a recurring plan.

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

Structure of PayWiserPlanPattern and PayWiserRetryPattern:

For daily recurrence:

Meaning Length Example Description
Type designator 1 D D - Daily
Start date 8 20160301 Recurring schedule start date in YYYYMMdi format
End date 8 ZZZZZZZZ Recurring schedule end date in YYYYMMdi format. If you do not wish to limit recurring payments with end date, this part should be >>ZZZZZZZ<<
Number of occurrences 4 0010 Number of occurrences
Predefined 2 02 Predefined
Regenerate every X days 3 003 Number of days in between payments

Example: D20160301ZZZZZZZZ001002003

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

For weekly recurrence:

Meaning Length Example Description
Type designator 1 W W - Weekly
Start date 8 20160301 Recurring schedule start date in YYYYMMdi format
End date 8 ZZZZZZZZ Recurring schedule end date in YYYYMMdi format. If you do not wish to limit recurring payments with end date, this part should be >>ZZZZZZZ<<
Number of occurrences 4 0010 Number of occurrences
Predefined 2 02 Predefined
Regenerate on Sunday 1 N Y for true, N for false
Regenerate on Monday 1 Y Y for true, N for false
Regenerate on Tuesday 1 N Y for true, N for false
Regenerate on Wednesday 1 N Y for true, N for false
Regenerate on Thursday 1 N Y for true, N for false
Regenerate on Friday 1 N Y for true, N for false
Regenerate on Saturday 1 N Y for true, N for false
Regenerate every X weeks3 003 Number of weeks in between payments

Example: W20160301ZZZZZZZZ001002NYNNNNN001

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

For For monthly recurrence:

Meaning Length Example Description
Type designator 1 M M - Monthly
Start date 8 20160301 Recurring schedule start date in YYYYMMdi format
End date 8 ZZZZZZZZ Recurring schedule end date in YYYYMMdi format. If you do not wish to limit recurring payments with end date, this part should be >>ZZZZZZZ<<
Number of occurrences 4 0010 Number of occurrences
Regeneration type 1 0 Regeneration type
End date type 1 2 End date type
Regenerate on specific day2 22 Day of the month when payment is to be made
Custom date part one 1 Z A - first, B - second, C - third, D - fourth, E - last
Custom date part two 1 Z A - day, B - weekday, C - weekend day, D - Sunday, E - Monday, F - Tuesday, G - Wednesday, H - Thursday, I - Friday, J - Saturday
Adjustment value 3 000 Adjustment value
Regenerate every X months3 003 Number of months in between payments

Example: M20160301ZZZZZZZZ00100229ZZ000001

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

For For Yearly recurrence:

Meaning Length Example Description
Type designator 1 Y Y - Yearly
Start date 8 20160301 Recurring schedule start date in YYYYMMdi format
End date 8 ZZZZZZZZ Recurring schedule end date in YYYYMMdi format. If you do not wish to limit recurring payments with end date, this part should be >>ZZZZZZZ<<
Number of occurrences 4 0010 Number of occurrences
Regeneration type 1 0 Regeneration type
End date type 1 2 End date type
Regenerate on specific day2 22 Day of the month when payment is to be made
Regenerate on specific month2 03 Month of the year when payment is to be made
Custom date part one 1 Z A - first, B - second, C - third, D - fourth, E - last
Custom date part two 1 Z A - day, B - weekday, C - weekend day, D - Sunday, E - Monday, F - Tuesday, G - Wednesday, H - Thursday, I - Friday, J - Saturday
Custom date part three 1 Z A - January, B - February, C - March, D - April, E - May, F - June, G - July, H - August, I - September, J - October, K - November, L - December
Adjustment value 3 000 Adjustment value

Example: Y20160301ZZZZZZZZ0010022203ZZZ000

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

PayWiserRecurringPlanId:   PayWiser Recurring Plan Id.

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

PayWiserRequestType:   The request type for the PayWiser gateway.

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

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:

Value Description
0 CreateRecurringPlan: Used to create new recurring plan, which can later on be used to start new recurring payments.
1 Tokenize: Used to generate a Token based on the Credit Card information, which can later on be used to start new recurring payments.
2 StartRecurringPayment: Used to create and start a new recurring payment for previously tokenized card. The Card Token must be specified via PayWiserCardToken configuration setting.
3 TerminateRecurringPlan: Used to terminate a recurring plan.
4 TerminateRecurringPayment: Used to terminate (end) recurring payment schedule immediately.

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

PayWiserRetryPattern:   PayWiser retry pattern for retrying failed payments.

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

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


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

PayWiserTokenReferenceId:   PayWiser Gateway Token Reference Id.

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

PhoeniXGateCardInfoKey:   PhoeniXGate Gateway Credit Card Info Key.

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

PhoeniXGateCheckInfoKey:   PhoeniXGate Gateway Check Info Key.

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

PhoeniXGateContractID:   PhoeniXGate Gateway Contract ID.

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

PhoeniXGateContractKey:   PhoeniXGate Gateway Contract Key.

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

PhoeniXGateCustomerKey:   PhoeniXGate Gateway Customer Key.

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

PhoeniXGateCustomerStatus:   Indicates the Customer Status.

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

Possible values are:

Value Description
0 Active
1 Inactive
2 Pending
3 Clsoed

The default value is 0 (Active).

PhoeniXGateNextBillingDate:   PhoeniXGate Gateway Next Billing Date.

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

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

PhoeniXGateNumberOfDays:   Number of days to be added to the next billing date.

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

PhoeniXGatePaymentType:   Indicates the Payment Type.

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

Possible values are:

Value Description
0 Credit Card
1 Check/ACH

The default value is 0 (Credit Card).

PhoeniXGateRequestType:   The request type for the PhoeniXGate gateway.

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

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:

Value Description
0 Customer Profile: Used to create a customer profile. This is the first step towards successfully storing and initiating recurring payments.
1 Credit Card Info: Used to to store a credit card number. The Customer Key must be specified via PhoeniXGateCustomerKey configuration setting.
2 Check Info: Used to store a checking account number. The Customer Key must be specified via PhoeniXGateCustomerKey configuration setting.
3 Recurring Payment: Used to create a payment schedule. The Customer Key must be specified via PhoeniXGateCustomerKey configuration setting.
4 Next Bill Date: Used to update the next billing date in the event that a payment was declined and a contract suspended. The Customer Key and Contract Key must be specified via PhoeniXGateCustomerKey, and PhoeniXGateContractKey configuration settings.
5 Get Token: Used to generate a Token based on the Credit Card information. The Customer Key must be specified via PhoeniXGateCustomerKey configuration setting.

The default value is 0 (Customer Profile).

PhoeniXGateToken:   PhoeniXGate Gateway Token Value.

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

PhoeniXGateTokenMode:   Indicates the Token Type.

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

Possible values are:

Value Description
0 Default (PhoeniXGate Gateway Default Format).
1 Card Format.

The default value is 0 (Gateway Format).

PlanetPaymentFrequencyDate:   The date of the month that a recurring payment should occur for the Planet Payment gateway.

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

PlanetPaymentFrequencyDay:   The day that a recurring payment should occur for the Planet Payment gateway.

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

Value Description
SUN Schedule runs on Sunday.
MON Schedule runs on Monday.
TUE Schedule runs on Tuesday.
WED Schedule runs on Wednesday.
THU Schedule runs on Thursday.
FRI Schedule runs on Friday.
SAT Schedule runs on Saturday.
DAY Schedule runs on the FIRST or LAST day.
WEEKDAY Schedule runs on the FIRST or LAST weekday.

Possible types are:

Type Description
FIRST Schedule runs on First FrequencyDay.
SECOND Schedule runs on Second FrequencyDay.
THIRD Schedule runs on Third FrequencyDay.
FOURTH Schedule runs on Fourth FrequencyDay.
LAST Schedule runs on Last FrequencyDay.

PlanetPaymentFrequencyMonth:   The month that a recurring payment should occur for the Planet Payment gateway.

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

Value Description
JAN Schedule runs in January.
FEB Schedule runs in February.
MAR Schedule runs in March.
APR Schedule runs in April.
MAY Schedule runs in May.
JUN Schedule runs in June.
JUL Schedule runs in July.
AUG Schedule runs in August.
SEP Schedule runs in September.
OCT Schedule runs in October.
NOV Schedule runs in November.
DEC Schedule runs in December.

QBMSTransactionType:   The Transaction Type for the QBMS gateway.

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

Value Description
0 Wallet: Used to create a wallet entry. A wallet must be created before creating a scheduled billing event.
1 Scheduled Billing: Used to create a scheduled billing event. The wallet Id must be specified via TransactionId.

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

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

component.Sale()
MyString = component.Config("RawRequest")
RawResponse:   Returns the data that was received from the gateway.

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

component.Sale()
MyString = component.Config("RawResponse")
RepayCardInfoKey:   Repay Gateway Credit Card Info Key.

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

RepayCheckInfoKey:   Repay Gateway Check Info Key.

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

RepayContractID:   Repay Gateway Contract ID.

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

RepayContractKey:   Repay Gateway Contract Key.

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

RepayCustomerKey:   Repay Gateway Customer Key.

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

RepayCustomerStatus:   Indicates the Customer Status.

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

Possible values are:

Value Description
0 Active
1 Inactive
2 Pending
3 Clsoed

The default value is 0 (Active).

RepayNextBillingDate:   Repay Gateway Next Billing Date.

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

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

RepayNumberOfDays:   Number of days to be added to the next billing date.

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

RepayPaymentType:   Indicates the Payment Type.

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

Possible values are:

Value Description
0 Credit Card
1 Check/ACH

The default value is 0 (Credit Card).

RepayRequestType:   The request type for the Repay gateway.

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

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:

Value Description
0 Customer Profile: Used to create a customer profile. This is the first step towards successfully storing and initiating recurring payments.
1 Credit Card Info: Used to to store a credit card number. The Customer Key must be specified via RepayCustomerKey configuration setting.
2 Check Info: Used to store a checking account number. The Customer Key must be specified via RepayCustomerKey configuration setting.
3 Recurring Payment: Used to create a payment schedule. The Customer Key must be specified via RepayCustomerKey configuration setting.
4 Next Bill Date: Used to update the next billing date in the event that a payment was declined and a contract suspended. The Customer Key and Contract Key must be specified via RepayCustomerKey, and RepayContractKey configuration settings.
5 Get Token: Used to generate a Token based on the Credit Card information. The Customer Key must be specified via RepayCustomerKey configuration setting.

The default value is 0 (Customer Profile).

RepayToken:   Repay Gateway Token Value.

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

RepayTokenMode:   Indicates the Token Type.

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

Possible values are:

Value Description
0 Default (Repay Gateway Default Format).
1 Card Format.

The default value is 0 (Gateway Format).

SkipJackStatusIndex:   Gets subscription details at the specified status index.

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

SquareCustomerCardCount:   The number of cards saved to the Square customer profile.

Square allows multiple credit cards to be saved to a customer profile. After retrieving a Square customer profile using GetSubscriptionStatus, this configuration setting can be queried to determine how many credit cards are saved to the profile.

SquareCustomerCardId:   The Id of a card saved to a Square customer profile.

This configuration setting holds the Id of a card-on-file associated with a Square customer profile.

This setting is automatically populated after creating a new card-on-file, or when SquareCustomerCardIndex is set after retrieving a Square customer profile.

This setting must be set before attempting to delete a card-on-file.

SquareCustomerCardIndex:   Which card's details to populate the class with from the retreived Square customer profile.

After retrieving a Square customer profile with GetSubscriptionStatus, this configuration setting can be used to select which card-on-file's details the class should reflect.

Valid values are -1 to (SquareCustomerCardCount - 1). Setting to -1 causes the class to reset/remove any currently populated Square customer card data.

SquareRequestType:   What type of Square customer data to create or delete.

This configuration setting controls what type of Square customer data is being created (when CreateSubscription is called) or deleted (when CancelSubscription is called). Possible values are:

  • 0: Customer Details (default)
  • 1: Customer Cards

When set to 0, the CreateSubscription and CancelSubscription methods will create and delete Square customer profiles.

When set to 1, the CreateSubscription and CancelSubscription methods will create and delete credit cards on the Square customer whose Id is specified by CustomerId.

Note that, regardless of this setting:

  • The GetSubscriptionStatus method will always retrieve all information associated with the Square customer profile whose Id is specified by CustomerId. (This includes all cards-on-file for that profile, refer to the SquareCustomerCardCount and SquareCustomerCardIndex configuration settings for more information.)
  • The UpdateSubscription method will always update the customer details using the information currently held by the class. (Square does not allow updating cards-on-file.)

StoreCardOnFile:   For the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF).

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.

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

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

TerminalCapability:   The capability of the terminal that is used to submit the transaction.

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

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

Value Description
1 Terminal has a magnetic stripe reader only.
2 Terminal has a magnetic stripe reader and manual entry capability.
3 Terminal has manual entry capability only.

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

Value Description
notused Terminal not used.
magstripe Magnetic stripe reader capability.
keyedonly Keyed entry only capability.

TerminalId:   Terminal Id value sent in the transaction.

Many gateways allow/require an Id (terminal, developer, client, user, etc) sent in addition to the MerchantLogin and MerchantPassword. This config is required by Nuvei and Planet Payment.

TerminalType:   The terminal type that is used to submit the transaction.

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

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

Value Description
StandAlone Point-of-Sale Credit Card Terminal
POS Electronic Cash Register
Unattended Unattended Terminal (i.e. Gas Pump)
Unspecified Used for all other applications

UseCardOnFile:   For the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request.

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.

XChildrenCount:   The number of child elements of the current element.

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.

XChildrenName[x]:   The name of the child element.

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.

XChildrenXText[x]:   The inner text of the child element.

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.

XElement:   The name of the current element.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

XPath:   Provides a way to point to a specific element in the returned XML or JSON response.

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:

'name' A particular element name
name[i] The i-th subelement of the current element with the given name
[i] The i-th subelement of the current element
[last()] The last subelement of the current element
[last()-i] The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"] The subelement containing a particular value for a given attribute (supports single AND double quotes). Not available for JSON responses.
.. The parent of the current element

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)

Document root Charge.XPath = "/"
Specific Element Charge.XPath = "/root/SubElement1/SubElement2/"
i-th Child Charge.XPath = "/root/SubElement1[i]"

Example (Setting XPath for JSON)

Document root Charge.XPath = "/"
Specific Element Charge.XPath = "/root/SubElement1/SubElement2/"
i-th Child Charge.XPath = "/root/SubElement1/[i]"

XText:   The text of the current element.

The current element is specified in the XPath configuration option.

This configuration option is read-only.

HTTP Configuration Settings

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

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

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

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

When true, the class 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".

The default value is True.

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

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 class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

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.

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

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

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

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

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

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.

ChunkSize:   Specifies the chunk size in bytes when using 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.

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

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

The default value is False.

EncodeURL:   If set to true the URL will be encoded by the class.

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

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

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

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same, otherwise the class fails with an error.

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

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

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

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Valid options are:

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

GetOn302Redirect:   If set to true the class will perform a GET on the new location.

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

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

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

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. 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 class 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 Windows 8.1/Server 2012 R2 or later. If HTTP/2 is used on a version of Windows prior to these versions the class fails with an error.

Note: HTTP/2 is currently only supported on Windows.

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

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.

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

If true, the component will not send the 'Connection: Close' header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note 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.

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

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

LogLevel:   The level of detail that is logged.

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

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

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

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

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

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

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

NegotiatedHTTPVersion:   The negotiated HTTP version.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TransferredRequest:   The full request as sent by the client.

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

.NET

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

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

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

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

UseIDNs:   Whether to encode hostnames to internationalized domain names.

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

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance to specify UTF-8 set CodePage to 65001. In the C++ Edition for Windows the *W version of the class must be used. For instance DNSW or HTTPW.

UserAgent:   Information about the user agent (browser).

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

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

IPPort Configuration Settings

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

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

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

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

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

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

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

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

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

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

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

FirewallPort:   The TCP port for the FirewallHost;.

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

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

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

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

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

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

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

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

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

When set, TCPKeepAlive will automatically be set to true. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no 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.

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

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

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

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

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

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

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

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

LingerTime:   Time in seconds to have the connection linger.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

MaxTransferRate:   The transfer rate limit in bytes per second.

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

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

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

www.google.com;www.nsoftware.com

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

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

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

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

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

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

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Configuration Settings

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

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.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

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

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

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

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

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

This functionality is available only when the provider is OpenSSL.

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

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

This functionality is available only when the provider is OpenSSL.

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

ReuseSSLSession:   Determines if the SSL session is reused.

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

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

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

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


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

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to true the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to false (default) the CRL check will not be performed by the class.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

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

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when UseInternalSecurityAPI is False (default):

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when UseInternalSecurityAPI is False (default) include:
  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when UseInternalSecurityAPI is True:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when UseInternalSecurityAPI is True include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

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

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

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.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

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

This setting is only applicable when UseInternalSecurityAPI is set to true.

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

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

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

SSLProvider:   The name of the security provider to use.

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

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

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

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

SSLSecurityFlags:   Flags that control certificate verification.

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

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

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

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 class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

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

IPPort.Config("UseInternalSecurityAPI=true");
IPPort.Config("SSLEnabledProtocols=3072"); //TLS 1.2
IPPort.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

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

TLS12SupportedGroups:   The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and 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)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

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

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

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

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

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

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

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

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

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

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

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

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

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

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

Socket Configuration Settings

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

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

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

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

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

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

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

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

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

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

Base Configuration Settings

BuildInfo:   Information about the product's build.

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

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

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

The following is a list of valid code page identifiers:

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

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

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

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

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g. RuntimeLicense, License File).
  • License Type: The type of license installed (e.g. Royalty Free, Single Server).
UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

Copyright (c) 2021 /n software inc. - All rights reserved.
E-Payment Integrator 2020 Qt Edition - Version 20.0 [Build 7941]