E-Payment Integrator V6 - Online Help
E-Payment Integrator V6
Questions / Feedback?

Recurringbilling Configuration

The bean 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 bean, access to these internal properties is provided through the Config method.

RecurringBilling Configuration Settings

AuthNetShipToCompany:   The name of the company associated with the customer.

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

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.

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.

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.

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.

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.

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.

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.

BeanstreamUsername:   The Username used for authentication with the Beanstream gateway.

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

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.

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)

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

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

CheckNumber:   Check Number.

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

CompanyName:   The Customer's Company Name.

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

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.

DateFormat:   The format of the date properties.

This field is used to specify the date format to be used for the various date properties: StartDate, EndDate, StartDate, EndDate, NextPaymentDate, and LastPaymentDate. 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

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 InitialAmount should be charged. The date is based on the format specified via DateFormat and must be the same as, or before StartDate. 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.

GoToBillingTransactionType:   The Transaction Type for the GoToBilling gateway.

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

Value Description
0 Recurring Transaction: Used to create or modify a recurring transaction. The customer Id must be specified via Id, 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 Id. An account must be created before creating a recurring transaction.

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

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.

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.

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.

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.

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

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.

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.

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.

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.

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

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

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

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

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.

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.

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.

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.

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.

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.

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

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

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

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

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.

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.

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.

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.

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.

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.

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

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

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

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.

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

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.

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.

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.

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

ECI:   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 XID and CAVV. This setting is only valid for E-Commerce transactions.

MerchantCode:   Required field for the Litle and MIT gateways, and optional field for the WorldPayXML gateway.

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

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

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 (Id)
"S" Use CustomerRefNum (Id) 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 (Id).
"OD" Pre-populate the Comments field (TransactionDesc) with the Customer Reference Number (Id).
"OA" Pre-populate the OrderId (InvoiceNumber) and Comments (TransactionDesc) fields with the Customer Reference Number (Id).

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

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.

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

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")
ValidateCardNumber:   Determines whether data set to the CardNumber or MagneticStripe property is validated.

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

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

XElement:   The name of the current element.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

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.

HTTP Configuration Settings

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

When AllowHTTPCompression is true, the bean 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 bean only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

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

AllowIdenticalRedirectURL:   Allow redirects to the same URL.

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

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 bean can be extended with other security schemes in addition to the authorization schemes already implemented by the bean.

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.

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

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

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

This option determines what happens when the server issues a redirect. Normally, the bean 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 bean throws an exception.

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

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

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

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

Valid options are:

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

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

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

HTTPVersion:   The version of HTTP used by the bean.

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

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

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

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.

MaxHeaders:   Instructs bean to save the amount of headers specified that are returned by the server after a Header event has been fired.

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

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

NOTE: This functionality is only available in Java and .NET.

MaxHTTPCookies:   Instructs bean to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.

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

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

NOTE: This functionality is only available in Java and .NET.

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

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

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

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

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

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

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

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

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

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

This is the same as Server. This setting is provided for use by beans 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 User. This setting is provided for use by beans that do not directly expose Proxy properties.

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

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

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.

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

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

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.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

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

UserAgent:   Information about the user agent (browser).

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

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

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.

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

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

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

FirewallListener:   If true, the component binds to a SOCKS firewall as a server (IPPort only).

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

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

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

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

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

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

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

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

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.

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.

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

If the bean 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 TCP port in the local host where the bean binds.

This must be set before a connection is attempted. It instructs the bean 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. The maximum value is 65536 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.

RecordLength:   The length of received data records.

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

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

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.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the bean will use IPv4 exclusively. When set to 1, the bean will use IPv6 exclusively. To instruct the bean 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

CloseStreamAfterTransfer:   If true, the component will close the upload or download stream after the transfer.

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

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.

SSL Configuration Settings

ReuseSSLSession:   Determines if the SSL session is reused.

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

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

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.

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

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

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

SSLContextProtocol:   The protocol used when getting an SSLContext instance.

Possible values are SSL, SSLv2, SSLv3, TLS and TLSv1. Use it only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call.

SSLTrustManagerFactoryAlgorithm:   The algorithm to be used to create a TrustManager through TrustManagerFactory.

Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call.

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

The enabled cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

Example values:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA");
Possible values include:
  • SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • SSL_RSA_WITH_RC4_128_SHA
  • SSL_RSA_WITH_DES_CBC_SHA
  • SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DH_anon_WITH_DES_CBC_SHA
  • SSL_RSA_EXPORT_WITH_RC4_40_MD5
  • SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
  • SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
  • SSL_DHE_DSS_WITH_DES_CBC_SHA
  • SSL_RSA_WITH_NULL_MD5
  • SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
  • SSL_DHE_RSA_WITH_DES_CBC_SHA
  • SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
  • SSL_RSA_WITH_NULL_SHA
  • SSL_DH_anon_WITH_RC4_128_MD5
  • SSL_RSA_WITH_RC4_128_MD5
  • SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • SSL_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_NULL_SHA
  • TLS_DH_anon_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_anon_WITH_RC4_128_SHA
  • TLS_DH_anon_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_KRB5_EXPORT_WITH_RC4_40_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_RC4_128_SHA
  • TLS_ECDH_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDH_anon_WITH_NULL_SHA
  • TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_RSA_WITH_NULL_SHA256
  • TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
  • TLS_KRB5_WITH_RC4_128_MD5
  • TLS_ECDHE_ECDSA_WITH_NULL_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_RC4_128_SHA
  • TLS_EMPTY_RENEGOTIATION_INFO_SCSV
  • TLS_KRB5_WITH_3DES_EDE_CBC_MD5
  • TLS_KRB5_WITH_RC4_128_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_NULL_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_WITH_DES_CBC_MD5
  • TLS_KRB5_EXPORT_WITH_RC4_40_MD5
  • TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
  • TLS_ECDH_anon_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_KRB5_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_NULL_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA

SSLEnabledCipherSuites is used together with SSLCipherStrength.

Note: This configuration setting is available only in .NET and Java.

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

GUIAvailable:   Tells the bean whether or not a message loop is available for processing events.

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

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

UseDaemonThreads:   Whether threads created by the bean are daemon threads.

If set to True, when the bean creates a thread the thread's Daemon property will be explicitly set to True. By default this setting is False and the bean will not set the Daemon property on the created thread.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0