RecurringBilling Class
Properties Methods Events Configuration Settings Errors
The RecurringBilling class is used to authorize and set up recurring transactions with any of the supported Internet Payment Gateways.
Syntax
InPayRecurringBilling
InPayRecurringBillingSwift
Remarks
The RecurringBilling class allows you to use multiple Internet Payment Gateways through one interface and one class. This allows for easy migration from one gateway to another, as well as quick integration into applications or web services.
RecurringBilling Gateway Setup and Required Properties
The RecurringBilling class allows your website to securely perform and setup recurring transactions without the need to redirect to a separate website. All transactions are accomplished through a secure HTTPS Post to any supported gateway. The secure response is received and then stored in the class's response properties. Any website or any stand-alone application can process transactions without the need for a secure server or third-party intervention.
Gateway Setup
The first thing you must do is select one of the many gateways supported by the RecurringBilling class, and set up an account with that gateway. Once you have an account set up with a valid (or test) login Id and password, you can use the RecurringBilling class.
To begin, set the Gateway property to the gateway you wish to use. If this gateway supports an alternate URL to send test transactions to, set the GatewayURL at this time.
Next, set the MerchantLogin (and for some gateways the MerchantPassword). These are supplied by your gateway vendor when you set up an account.
Many gateways have different setup requirements. See RecurringBilling Gateway Setup and Required Properties for details about each gateway's requirements.
Now you are ready to process transactions. For each transaction, you must set either Card or Bank. Most gateways will also require additional properties, such as CustomerAddress, CustomerFirstName, CustomerLastName, InvoiceNumber, etc.
Subscription Management
Once all required properties are set, you may create a recurring payment using the specified card or bank data by calling the CreateSubscription method. If the Gateway supports it, you may also Cancel recurring payments with the CancelSubscription method. Recurring payments that need to be changed may be updated with the UpdateSubscription method.
The following gateways are supported by the RecurringBilling class:
Gateway | Home page |
No Gateway (0) | n/a |
Authorize.Net AIM (1) | http://www.authorize.net |
eProcessing Transparent Database Engine (2) | http://www.eProcessingNetwork.com |
iTransact RediCharge HTML (4) | http://www.itransact.com |
PayFlow Pro (6) | https://www.paypal.com/webapps/mpp/payflow-payment-gateway |
USA ePay CGI Transaction Gateway (7) | http://www.usaepay.com |
Plug 'n Pay (8) | http://www.plugnpay.com |
Planet Payment iPay (9) | http://planetpayment.com/ |
Merchant Anywhere (Transaction Central) (15) | http://www.merchantanywhere.com/ |
SkipJack (16) | http://www.skipjack.com |
Chase Paymentech Orbital Gateway (23) | https://merchantservices.chase.com/ |
LinkPoint (24) | http://www.linkpoint.com |
Moneris eSelect Plus Canada (25) | http://www.moneris.com |
NetworkMerchants Direct-Post API (28) | http://www.nmi.com/ |
TransFirst Transaction Central Classic (formerly PRIGate) (30) | www.transfirst.com |
Merchant Partners (Transaction Engine) (31) | http://www.merchantpartners.com/ |
First Data Global Gateway (Linkpoint) (33) | http://www.firstdata.com |
YourPay (Linkpoint) (34) | http://www.yourpay.com |
ACH Payments AGI (35) | http://www.ach-payments.com |
Forte AGI / Payments Gateway AGI(36) | https://www.forte.net/ |
Cyber Source SOAP API (37) | http://www.cybersource.com |
eWay XML API (Australia) (38) | http://www.eway.com.au/ |
Chase Merchant Services (Linkpoint) (41) | http://www.chase.com |
Thompson Merchant Services NexCommerce (iTransact mode) (42) | http://www.thompsonmerchant.com |
TransFirst Transaction Central (44) | http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate) |
Elavon/NOVA/My Virtual Merchant (49) | http://www.myvirtualmerchant.com |
Moneris eSelect Plus USA (52) | http://www.moneris.com |
Bambora / Beanstream Process Transaction API (53) | https://www.bambora.com/en/ca/ |
Verifi Direct-Post API (54) | http://www.verifi.com |
Intuit QuickBooks Merchant Services (QBMS) (61) | This gateway is no longer in service. |
Litle Online Gateway (63) | http://www.litle.com/ |
PayTrace Payment Gateway (70) | https://www.paytrace.net/ |
TransNational Bankcard (74) | http://www.tnbci.com/ |
Payscape (83) | http://www.payscape.com |
Authorize.NET CIM (85) | http://www.authorize.net |
WorldPay US Link Gateway (87) | https://www.worldpay.com/en-us/index |
3DSI Payment WorkSuite (88) | http://www.3dsi.com/ |
First Data PayPoint (90) | https://www.firstdata.com/en_us/customer-center/financial-institutions/paypoint.html |
Converge (formerly MyVirtualMerchant) (93) | https://support.convergepay.com/s/ |
PhoeniXGate Gateway (97) | http://www.phoenixmanagednetworks.com/ |
Repay Gateway (98) | https://www.repay.com/ |
PayWiser (98) | http://www.paywiser.si/ |
BlueSnap Gateway (104) | https://home.bluesnap.com/ |
BASYS Gateway (106) | https://basyspro.com/ |
Square (108) | https://www.squareup.com |
Nuvei / GlobalOnePay (110) | https://nuvei.com/en-us/ |
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
- cardType | Type of credit card being used in this transaction. |
- cardCVVData | Three digit security code on back of card (optional). |
- cardCVVPresence | Indicates the presence of the card verification value. |
- cardEntryDataSource | This property contains a 1-character code identifying the source of the customer data. |
- cardExpMonth | Expiration month of the credit card specified in Number . |
- cardExpYear | Expiration year of the credit card specified in Number . |
- cardIsEncrypted | Determines whether data set to the Number or MagneticStripe properties is validated. |
- cardMagneticStripe | Track data read off of the card's magnetic stripe. |
- cardNumber | Customer's credit card number for the transaction. |
- customerAddress | Customer's street address. |
- customerAddress2 | A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc. |
- customerAggregate | This property allows you to get or set an XML aggregate built from all of the Customer properties. |
- customerCity | Customer's city. |
- customerCountry | Customer's country. |
- customerEmail | Customer's email address. |
- customerFax | Customer's fax number. |
- customerFirstName | Customer's first name. |
- customerFullName | Customer's full name. |
- customerId | Merchant-generated customer Id. |
- customerLastName | Customer's last name. |
- customerPhone | Customer's phone number. |
- customerState | Customer's state. |
- customerZip | Customer's zip code (or postal code if outside of the USA). |
- bankAccountClass | Indicates whether a personal or business account is used for this transaction. |
- bankAccountHolderName | Account holder's name. |
- bankAccountNumber | Bank account number for ACH transactions. |
- bankAccountType | Indicates whether a checking or savings account is used for this transaction. |
- bankName | Name of the account holder's bank. |
- bankRoutingNumber | Routing number for ACH transactions. |
- ECheckPaymentType | The type of check payment request (commonly referred to as SEC Code). |
- gateway | Gateway to process transactions with. |
- gatewayURL | Default URL for a specific Gateway . |
- invoiceNumber | Merchant-generated invoice number. |
- merchantLogin | Merchant's Gateway login. |
- merchantPassword | Merchant's Gateway password. |
- paymentScheduleEndDate | The end date of the subscription. |
- paymentScheduleFrequency | The frequency of payments. |
- paymentScheduleFrequencyUnit | The unit of time to be used when calculating the frequency of payments. |
- paymentScheduleInitialAmount | The initial amount to be charged (such as a trial period or setup fee). |
- paymentScheduleRecurAmount | The amount to be charged on a recurring basis. |
- paymentScheduleStartDate | The date on which the recurring payments will start processing. |
- paymentScheduleTotalPayments | The total number of payments. |
- paymentScheduleTrialPayments | The total number of trial payments. |
- proxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
- proxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
- proxyPassword | This property contains a password if authentication is to be used for the proxy. |
- proxyPort | This property contains the TCP port for the proxy Server (default 80). |
- proxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
- proxySSL | This property determines when to use SSL for the connection to the proxy. |
- proxyUser | This property contains a user name, if authentication is to be used for the proxy. |
- responseApprovalCode | Contains an authorization code when a transaction has been approved. |
- responseApproved | Indicates the status of the last transaction. |
- responseAVSResult | Contains the Address Verification System result code. |
- responseCode | Indicates the status of the authorization request. |
- responseCVVResult | Contains the returned CVV2 result code if it was requested. |
- responseData | The entire response returned from the gateway processor. |
- responseErrorCode | Additional error code returned by some gateways. |
- responseErrorText | Additional error description returned by some gateways. |
- responseInvoiceNumber | Invoice number submitted in authorization request (if applicable). |
- responseProcessorCode | Response code from the underlying processor. |
- responseSubscriptionId | Contains the Subscription or Profile Identifier for the recurring payment. |
- responseText | Text information that describes each response code. |
- responseTransactionId | Contains the Visa Transaction Identifier or MasterCard Reference Number. |
- shippingAddress | Customer's shipping street address. |
- shippingAddress2 | A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc. |
- shippingCity | Customer's shipping city. |
- shippingCountry | Customer's shipping country. |
- shippingEmail | Customer's email address. |
- shippingFirstName | Customer's first name. |
- shippingLastName | Customer's last name. |
- shippingPhone | Customer's phone number. |
- shippingState | Customer's shipping state. |
- shippingZip | Customer's shipping zip code (or postal code if outside of the USA). |
- specialFieldCount | The number of records in the SpecialField arrays. |
- specialFieldName:(int)fieldIndex | Name of special configuration property to submit in this transaction. |
- specialFieldValue:(int)fieldIndex | Value of special configuration property to submit in this transaction. |
- SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
- SSLCertEncoded | The certificate (PEM/base64 encoded). |
- SSLCertStore | The name of the certificate store for the client certificate. |
- SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
- SSLCertStoreType | The type of certificate store for this certificate. |
- SSLCertSubject | The subject of the certificate used for client authentication. |
- SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
- subscriptionDesc | Description of recurring subscription. |
- subscriptionDetailsCardExpMonth | The expiration month of the card currently being processed for the recurring payments. |
- subscriptionDetailsCardExpYear | The expiration year of the card currently being processed for the recurring payments. |
- subscriptionDetailsCardNumber | The card number currently being processed for the recurring payments. |
- subscriptionDetailsEndDate | The date in which the recurring payments will stop processing. |
- subscriptionDetailsFrequency | The frequency in which payments will occur. |
- subscriptionDetailsFrequencyUnit | The unit frequency in which the payments will be processed. |
- subscriptionDetailsLastPaymentDate | The date that the last/previous transaction was processed. |
- subscriptionDetailsNextPaymentDate | The date of the next upcoming transaction. |
- subscriptionDetailsRecurAmount | The amount being charged on a recurring basis. |
- subscriptionDetailsRemainingPayments | The total number of remaining payments until the recurring payments will stop processing. |
- subscriptionDetailsStartDate | The date in which the recurring payments started processing. |
- subscriptionDetailsStatus | The current status of the recurring subscription. |
- subscriptionDetailsSubscriptionId | Contains the Subscription or Profile Identifier for the recurring payment. |
- subscriptionDetailsSubscriptionName | Contains the name of the recurring subscription or profile. |
- subscriptionDetailsTotalPayments | The total number of payments. |
- subscriptionName | The name of the recurring subscription or profile. |
- testMode | Turns test mode on and off for transactions sent to the current Gateway . |
- timeout | A timeout for the class. |
- transactionId | Merchant-generated transaction Id used for all transactions. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
- addSpecialField | Adds a special field name and the corresponding value. |
- cancelSubscription | Cancels or deletes a recurring payment subscription. |
- config | Sets or retrieves a configuration setting. |
- createSubscription | Creates a new recurring subscription. |
- doEvents | Processes events from the internal message queue. |
- getResponseVar | Parses additional information out of the response. |
- getSubscriptionStatus | Retrieves the status of a recurring payment subscription. |
- interrupt | Interrupts the current action. |
- resetSpecialFields | Resets all special fields to the default settings. |
- updateSubscription | Updates a recurring payment subscription. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
- onError | Information about errors during data delivery. |
- onSSLServerAuthentication | Fired after the server presents its certificate to the client. |
- onSSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
3DSECI | Electronic Commerce Indicator. |
AmountFormat | Used to set the input format for TransactionAmount. |
AuthNetCIMGuestProfile | Specifies whether a profile is a guest profile or a normal profile. |
AuthNetCIMMaskedCardNumber | The masked card number returned for the payment profile at the specified index. |
AuthNetCIMPaymentProfileCount | The number of Payment Profiles assigned to a customer profile within the Authorize.NET CIM gateway. |
AuthNetCIMPaymentProfileId | The Payment Profile ID assigned by Authorize.NET CIM gateway. |
AuthNetCIMPaymentProfileIndex | Parses the Payment Profile contained at the specified index within a GetSusbcriptionStatus response. |
AuthNetCIMRequestType | The request type to send for the Authorize.NET CIM gateway. |
AuthNetCIMShippingAddressCount | The number of Shipping Addresses assigned to a customer profile within the Authorize.NET CIM gateway. |
AuthNetCIMShippingAddressId | The Shipping Address ID assigned by Authorize.NET CIM gateway. |
AuthNetCIMShippingAddressIndex | Parses the Shipping Address contained at the specified index within a GetSusbcriptionStatus response. |
AuthNetGetSubscriptionDetails | Specifies whether a call to GetSubscriptionStatus will return the details of the subscription or just the status. |
AuthNetOpaqueDescriptor | An Authorize.Net opaque data descriptor. |
AuthNetOpaqueValue | An Authorize.Net opaque data value. |
AuthNetShipToCompany | The name of the company associated with the customer's shipping address. |
BamboraUsername | The Username used for authentication with the Bambora gateway. |
BASYSCardInfoKey | BASYS Gateway Credit Card Info Key. |
BASYSCheckInfoKey | BASYS Gateway Check Info Key. |
BASYSContractID | BASYS Gateway Contract ID. |
BASYSContractKey | BASYS Gateway Contract Key. |
BASYSCustomerKey | BASYS Gateway Customer Key. |
BASYSCustomerStatus | Indicates the Customer Status. |
BASYSNextBillingDate | BASYS Gateway Next Billing Date. |
BASYSNumberOfDays | Number of days to be added to the next billing date. |
BASYSPaymentType | Indicates the Payment Type. |
BASYSRequestType | The request type for the BASYS gateway. |
BASYSToken | BASYS Gateway Token Value. |
BASYSTokenMode | Indicates the Token Type. |
BlueSnapCardCount | How many card payment sources the last retrieved vaulted shopper has. |
BlueSnapCardIndex | Determines which card payment source the class's fields are populated for currently. |
BlueSnapEnterpriseUdfs | User-Defined Fields (UDFs) to send when updating a BlueSnap vaulted shopper. |
BlueSnapGetToken | Retrieves a new hosted payment fields token (pfToken) from BlueSnap. |
BlueSnapRequestType | The request type for the BlueSnap gateway. |
BlueSnapVaultedShopperId | BlueSnap gateway vaulted shopper ID. |
CardIssueNumber | Special Issue Number used for Switch and Solo cards. |
CardLast4Digits | The last 4 digits of a credit card. |
CardPresent | Specifies whether the card is present during the transaction. |
CardStartMonth | Used for some international cards. |
CardStartYear | Used for some international cards. |
CardToken | The credit card token. |
CardType | Type of credit card being used in this transaction. |
CheckNumber | Check Number. |
CheckRoutingNumber | Determines whether to perform a checksum test on the RoutingNumber. |
CompanyName | The Customer's Company Name. |
ConvenienceFee | The total convenience fee charged for a transaction. |
CustomerPassword | The Customer's Password. |
CustomerUsername | The Customer's Username. |
CyberSourceDeleteSubscription | Whether subscriptions should be deleted when CancelSubscription is called. |
CyberSourceXMLEscape | Determines whether to XML escape the CyberSource gateway request field values. |
DateFormat | The format of the date properties. |
EscapeXML | Automatically escape data within XML tags. |
EwayCustomerId | The Customer Id used to authenticate with the Eway gateway. |
EwayInitialDate | The date of the initial payment for the Eway gateway. |
EwayTransactionType | The Transaction Type for the Eway gateway. |
FirstDataPayPointAgreedToTerms | Specifies whether the customer has approved the registration process and agreed to the terms for the FirstDataPayPoint gateway. |
FirstDataPayPointTransactionType | The Transaction Type for the FirstDataPayPoint gateway. |
HashAlgorithm | Algorithm used for hashing. |
HashSecret | Security key used to generate a hash for gateways supporting such functionality. |
LicenseDOB | Customer's Date of Birth as indicated on his drivers license. |
LicenseNumber | Customer's driver's license number. |
LicenseState | State in which customer's driver's license was issued. |
LitleCardholderId | Describes the method used to identify the cardholder at the point of sale for the Litle gateway. |
LitleSubscriptionAggregate | Used to specify an XML aggregate for Subscription Create and Update transactions within the Litle gateway. |
LitleTransactionType | The Transaction Type for the Litle gateway. |
LitleTrialFrequency | Used to specify a trial frequency for the Litle gateway. |
MerchantCode | A gateway-supplied merchant number, code, or Id. |
MerchantPartnersLast4Digits | The last 4 digits of the account number for a transaction processed via the MerchantPartners or WorldPay Link gateways. |
MerchantPartnersReaderType | The reader type used to read and encrypt a swiped card for the MerchantPartners or WorldPay Link gateways. |
MITFlag | For the MIT framework - Used to indicate that a transaction is merchant initiated. |
MITPriorTransId | For the MIT framework - Used to specify a prior transaction id to be referenced in a merchant initiated transaction. |
MITType | For the MIT framework - Indicates the type of transaction being requested in a Merchant-Initiated Transaction (MIT). |
MyVirtualMerchantUserId | The MyVirtualMerchant user Id as configured on VirtualMerchant. |
NetBillingVersion | The Version to be sent in the User-Agent heading of a NetBilling gateway request. |
NuveiPermittedTerminals | A list of the terminals permitted to use a Nuvei secure card. |
OmniFundTransactionType | The Transaction Type for the OmniFund gateway. |
OrbitalConnectionPassword | Orbital Connection Password field used by the Orbital gateway. |
OrbitalConnectionUsername | Orbital Connection Username field used by the Orbital gateway. |
OrbitalCustomerProfileFromOrderInd | Customer Profile Number generation Options for the Orbital gateway. |
OrbitalCustomerProfileOrderOverrideInd | Indicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway. |
PayerIP | The IP address of the payer. |
PaymentWorkSuiteClientCode | The 3DSI assigned client code sent in a request to the PaymentWorksuite gateway. |
PaymentWorkSuiteLocationCode | The 3DSI assigned location code sent in a request to the PaymentWorksuite gateway. |
PaymentWorkSuiteMerchantCode | The 3DSI assigned merchant code sent in a request to the PaymentWorksuite gateway. |
PaymentWorkSuiteTransactionType | The transaction type to send for the Payment WorkSuite gateway. |
PayTraceIntegratorId | Used to specify the Integrator Id value assigned by the PayTrace gateway. |
PayTraceTransactionType | The Transaction Type for the PayTrace gateway. |
PayWiserCardToken | PayWiser Gateway Card Token Value. |
PayWiserPaymentHour | Payment hour. |
PayWiserPlanPattern | PayWiser plan pattern for creating a recurring plan. |
PayWiserRecurringPlanId | PayWiser Recurring Plan Id. |
PayWiserRequestType | The request type for the PayWiser gateway. |
PayWiserRetryPattern | PayWiser retry pattern for retrying failed payments. |
PayWiserTokenReferenceId | PayWiser Gateway Token Reference Id. |
PhoeniXGateCardInfoKey | PhoeniXGate Gateway Credit Card Info Key. |
PhoeniXGateCheckInfoKey | PhoeniXGate Gateway Check Info Key. |
PhoeniXGateContractID | PhoeniXGate Gateway Contract ID. |
PhoeniXGateContractKey | PhoeniXGate Gateway Contract Key. |
PhoeniXGateCustomerKey | PhoeniXGate Gateway Customer Key. |
PhoeniXGateCustomerStatus | Indicates the Customer Status. |
PhoeniXGateNextBillingDate | PhoeniXGate Gateway Next Billing Date. |
PhoeniXGateNumberOfDays | Number of days to be added to the next billing date. |
PhoeniXGatePaymentType | Indicates the Payment Type. |
PhoeniXGateRequestType | The request type for the PhoeniXGate gateway. |
PhoeniXGateToken | PhoeniXGate Gateway Token Value. |
PhoeniXGateTokenMode | Indicates the Token Type. |
PlanetPaymentFrequencyDate | The date of the month that a recurring payment should occur for the Planet Payment gateway. |
PlanetPaymentFrequencyDay | The day that a recurring payment should occur for the Planet Payment gateway. |
PlanetPaymentFrequencyMonth | The month that a recurring payment should occur for the Planet Payment gateway. |
QBMSTransactionType | The Transaction Type for the QBMS gateway. |
RawRequest | Returns the data that was sent to the gateway. |
RawResponse | Returns the data that was received from the gateway. |
RepayCardInfoKey | Repay Gateway Credit Card Info Key. |
RepayCheckInfoKey | Repay Gateway Check Info Key. |
RepayContractID | Repay Gateway Contract ID. |
RepayContractKey | Repay Gateway Contract Key. |
RepayCustomerKey | Repay Gateway Customer Key. |
RepayCustomerStatus | Indicates the Customer Status. |
RepayNextBillingDate | Repay Gateway Next Billing Date. |
RepayNumberOfDays | Number of days to be added to the next billing date. |
RepayPaymentType | Indicates the Payment Type. |
RepayRequestType | The request type for the Repay gateway. |
RepayToken | Repay Gateway Token Value. |
RepayTokenMode | Indicates the Token Type. |
SkipJackStatusIndex | Gets subscription details at the specified status index. |
SquareCustomerCardCount | The number of cards saved to the Square customer profile. |
SquareCustomerCardId | The Id of a card saved to a Square customer profile. |
SquareCustomerCardIndex | Which card's details to populate the class with from the retreived Square customer profile. |
SquareRequestType | What type of Square customer data to create or delete. |
StoreCardOnFile | For the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF). |
TaxId | Company's Tax Id or a Customer's Social Security Number. |
TerminalCapability | The capability of the terminal that is used to submit the transaction. |
TerminalId | Terminal Id value sent in the transaction. |
TerminalType | The terminal type that is used to submit the transaction. |
UseCardOnFile | For the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request. |
XChildrenCount | The number of child elements of the current element. |
XChildrenName[x] | The name of the child element. |
XChildrenXText[x] | The inner text of the child element. |
XElement | The name of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |