Retail Class
Properties Methods Events Configuration Settings Errors
The Retail component is used to authorize credit card transactions with any of the supported Internet Payment Gateways.
Syntax
inpay.retail()
Remarks
The Retail 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.
The Retail class allows your website to securely perform credit card transactions without the need to redirect to a third-party site. 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 web site on a standard HTTP server or any stand-alone application can process transactions without the need for a secure server or third-party intervention.
The first thing you must do is select one of the many gateways supported by the Retail class, and set up an account with that gateway vendor. Once you have an account set up with a valid (or test) login Id and password, you can use the Retail 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.
Now you are ready to process transactions. For each transaction, you can set the Card and TransactionAmount properties. For swiped card transactions you can set CardMagneticStripe or for manually entered transactions you can set CardNumber, CardExpMonth, CardExpYear. Most gateways will also require additional properties, such as CustomerAddress, CustomerFirstName, CustomerLastName, InvoiceNumber, etc. Any additional required properties are listed in the Gateway property description.
Once these properties are set, you may run validity checks on the card data with the AVSOnly method, or simply authorize the transaction with the Sale method. If your Gateway supports them, you may also perform a wide variety of transaction types such as VoidTransaction, Refund, Credit, or Force. Please review the method pages for further details about these methods and their designed functionality.
The following gateways are supported by the Retail 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 |
| NetBilling DirectMode (5) | http://www.netbilling.com |
| Verisign 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/ |
| MPCS (10) | http://merchantcommerce.net/ |
| RTWare (11) | http://www.rtware.net/ |
| ECX (12) | http://www.ecx.com |
| Bank of America (Global Gateway e4) (13) | http://bankofamerica.com/merchantservices |
| Merchant Anywhere (Transaction Central) (15) | http://www.merchantanywhere.com/ |
| SkipJack (16) | http://www.skipjack.com |
| TrustCommerce API (19) | http://www.trustcommerce.com |
| PayFuse XML (ClearCommerce Engine) (21) | http://www.firstnationalmerchants.com/ |
| LinkPoint (24) | http://www.linkpoint.com |
| Fast Transact VeloCT (Direct Mode) (27) | http://www.fasttransact.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 |
| Payments Gateway AGI (36) | https://www.paymentsgateway.net/ |
| Cyber Source SOAP API (37) | http://www.cybersource.com |
| goEmerchant XML (39) | http://www.goemerchant.com/ |
| 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) |
| Sterling SPOT XML API (HTTPS POST) (45) | http://www.sterlingpayment.com |
| PayJunction Trinity Gateway (46) | http://www.payjunction.com |
| Elavon/NOVA/My Virtual Merchant (49) | http://www.myvirtualmerchant.com |
| Verifi Direct-Post API (54) | http://www.verifi.com |
| Merchant E-Solutions Payment Gateway (Trident API) (56) | http://merchante-solutions.com/ |
| PayLeap Web Services API (57) | http://www.payleap.com |
| Worldpay XML (Direct/Invisible) (59) | http://www.worldpay.com |
| ProPay Merchant Services API (60) | http://www.propay.com |
| Intuit QuickBooks Merchant Services (QBMS) (61) | http://payments.intuit.com/ |
| Heartland POS Gateway (62) | http://www.heartlandpaymentsystems.com/ |
| Litle Online Gateway (63) | http://www.litle.com/ |
| BrainTree DirectPost (Server-to-Server Orange) Gateway (64) | http://www.braintreepaymentsolutions.com/ |
| JetPay Gateway (65) | http://www.jetpay.com/ |
| HSBC XML API (ClearCommerce Engine) (66) | http://www.business.hsbc.co.uk/1/2/business-banking/business-payment-processing/business-debit-and-credit-card-processing |
| BluePay 2.0 Post (67) | http://www.bluepay.com |
| PayTrace Payment Gateway (70) | http://www.paytrace.com/ |
| TransNational Bankcard (74) | http://www.tnbci.com/ |
| First Data Global Gateway E4 (80) | http://www.firstdata.com |
| Bluefin (82) | http://www.bluefin.com/ |
| Payscape (83) | http://www.payscape.com |
| Pay Direct (Link2Gov) (84) | http://www.fisglobal.com/products-government-governmentpayments |
| WorldPay US Link Gateway (87) | http://www.worldpay.com/us |
| 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 (93) | http://www.myvirtualmerchant.com |
| Payeezy Gateway (formerly First Data E4) (94) | https://www.payeezy.com |
| Authorize.NET AIM XML (96) | http://www.authorize.net |
| PhoeniXGate Gateway (97) | http://www.phoenixmanagednetworks.com/ |
| Repay Gateway (98) | http://www.repayonline.com/ |
| BASYS Gateway (106) | https://basyspro.com/ |
| Quickbooks Payments (113) | https://quickbooks.intuit.com/payments/ |
| Shift4 (114) | https://www.shift4.com/ |
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| AuthCode | Authorization code from a previous 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 . |
| 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). |
| Gateway | Gateway to process transactions with. |
| GatewayURL | Default URL for a specific Gateway . |
| InvoiceNumber | Merchant-generated invoice number. |
| Level2Aggregate | The level 2 aggregate containing the data to be sent in the request. |
| Level3Aggregate | The level 3 aggregate containing the data to be sent in the request. |
| MerchantLogin | Merchant's Gateway login. |
| MerchantPassword | Merchant's Gateway password. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component 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. |
| ResponseApprovedAmount | The amount approved for the transaction, this is the amount actually charged to the credit card. |
| 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. |
| 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 | Name of special configuration property to submit in this transaction. |
| SpecialFieldValue | 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). |
| TestMode | Turns test mode on and off for transactions sent to the current Gateway . |
| Timeout | A timeout for the component. |
| TransactionAmount | Purchase amount for an authorization transaction. |
| TransactionDesc | Description of goods purchased. |
| 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. |
| AuthOnly | Initiates an authorization-only request transaction. |
| AVSOnly | Used to check the validity of the card without authorizing funds. |
| Capture | Captures a previously authorized transaction. |
| Config | Sets or retrieves a configuration setting . |
| Credit | Credits a customer's card. |
| DoEvents | Processes events from the internal message queue. |
| Force | Used when authorization cannot be obtained online. |
| GetResponseVar | Parses additional information out of the response. |
| Interrupt | Interrupts the current action. |
| Refund | Refunds a previously captured transaction. |
| ResetSpecialFields | Resets all special fields to the default settings. |
| Sale | Initiates an Sale transaction (authorization and capture). |
| VoidTransaction | Voids a previously authorized transaction. |
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.
| Error | Information about errors during data delivery. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | 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.
| CardEncrypted | Specifies whether the card magnetic stripe data is encrypted. |
| CardPresent | Specifies whether the card is present during the transaction. |
| CardType | Type of credit card being used in this transaction. |
| DebitKSN | Clear-text Key Sequence Number retrieved from a PIN pad. |
| DebitPIN | DUKPT DES encrypted pin block, retrieved from a PIN pad. |
| TerminalManufacturer | The manufacturer of the terminal used to submit the transaction. |
| TerminalModel | The model of the terminal used to submit the transaction. |
| TerminalType | The terminal type that is used to submit the transaction. |
| TerminalCapability | The capability of the terminal that is used to submit the transaction. |
| BluePayKSN | The Key Serial Number (KSN) used to encrypt the card magnetic stripe data for the BluePay gateway. |
| BluePayPreEncryptedTrackLength | The length of the magnetic stripe data prior to encryption for the BluePay gateway. |
| LitleCardholderID | Describes the method used to identify the cardholder at the point of sale for the Litle gateway. |
| MerchantPartnersReaderType | The reader type used to read and encrypt a swiped card for the MerchantPartners or WorldPay Link gateways. |
| AuthNetSplitTenderId | Authorize.Net assigned id for partially authorized transactions. |
| AllowPartialAuths | Specifies whether partial authorizations are allowed. |
| ApplePayData | The Base-64 encoded data containing the encrypted payment data from Apple for use when performing Apple Pay transactions. |
| AuthenticationStatus | Indicates whether a transaction qualifies as a ThreeDSecure (3DS) authenticated transaction. |
| BluePayMasterId | Used to reference a previous transaction in BluePay. |
| BluePayUpdate | Used to perform an Update transaction for BluePay. |
| CardholderPresentCode | Specifies the way in which transaction took place. |
| CAVV | Cardholder Authentication Verification Value from a 3D Secure authentication. |
| CAVVResponse | Contains CAVV response value returned by the gateway. |
| CurrencyCode | Currency code for the currency of the transaction. |
| CurrencyExponent | Currency exponent to be used in conjunction with the Currency code of the transaction. |
| DynamicDescriptor | A merchant defined transaction description which appears on the customer's credit card statement. |
| MerchantAlias | An additional merchant property used to specify an alias for the merchant. |
| SurchargeAmount | Used to specify the amount of the surcharge for the transaction. |
| TerminalId | Terminal Id value sent in the transaction. |
| TipAmount | Used to specify the amount of the tip for the transaction. |
| UserId | Used to specify an Id for the API user. |
| XID | TransactionId from a 3D Secure authentication. |
| CyberSourceAuthToken | The request token from a previous authorization for the CyberSource gateway. |
| CyberSourceProfileId | The Id of a Customer's Profile stored within the CyberSource gateway. |
| CyberSourceVoidMode | Indicates whether to perform a Void or Reversal. |
| FDMSCurrentBalance | Contains the current card balance value returned in a response for the First Data E4, Payeezy, and Bank Of America gateways. |
| FDMSGiftCardTransactionType | Specifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways. |
| FDMSKeyId | The Key Id that corresponds to the HMAC Key for the First Data E4, Payeezy, and Bank Of America gateways. |
| FDMSProcessGiftCard | Specifies whether the card being processed is a gift card for the First Data E4, Payeezy, and Bank Of America gateways. |
| FDMSTransArmorToken | The Transarmor token that replaces a card number and used for transaction processing. |
| GlobalIrisRefundPassword | The Refund password for the Global Iris gateway. |
| GoEMerchantUseGatewayId | Indicates whether to send a password or gateway Id for the GoEMerchant gateway. |
| HeartlandDeveloperId | Optional DeveloperId field used by the Heartland gateway. |
| HeartlandDeviceId | DeviceId field required by the Heartland gateway. |
| HeartlandLicenseId | LicenseId field required by the Heartland gateway. |
| HeartlandReversalAmount | The settlement amount to be used when performing a reversal for the Heartland gateway. |
| HeartlandShipDay | Ship day field required by the Heartland gateway e-commerce/direct marketing transactions. |
| HeartlandShipMonth | Ship month field required by the Heartland gateway e-commerce/direct marketing transactions. |
| HeartlandSiteId | SiteId field required by the Heartland gateway. |
| HeartlandSiteTrace | Optional transaction identifier for the Heartland gateway. |
| HeartlandTokenMapping | The type of token to return when using Tokenization with the Heartland gateway. |
| HeartlandTokenValue | Used to retrieve or specify a Heartland token value. |
| HeartlandVersionNumber | Optional VersionNumber field used by the Heartland gateway. |
| LitleCustomBillingAggregate | Used to specify an XML aggregate for Custom Billing support within the Litle gateway. |
| MerchantPartnersLast4Digits | The last 4 digits of the card number for a transaction processed via the MerchantPartners gateway. |
| MerchantPartnersProfileId | The profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways. |
| MITAESSeedId | The Seed Id used to perform AES encryption for the MIT gateway. |
| MITBranchId | Branch reference number for the MIT gateway. |
| MITCompanyId | Company reference number for the MIT gateway. |
| MITCountry | Country of operation for the MIT gateway. |
| MITEncryptionAlgorithm | The Encryption Algorithm to use with the MIT gateway. |
| MITEncryptionKey | The Encryption Key to use with the MIT gateway. |
| MITRecurring | Specifies whether to perform a recurring transaction request for the MIT gateway. |
| MITTPOperation | The operation type for the MIT gateway. |
| MonerisNVPAPI | Indicates whether to use the NVP API for the gwMoneris and gwMonerisUSA gateway. |
| MyVirtualMerchantTransactionType | Used to override the transaction type to send in a transaction for the MyVirtualMerchant and Converge gateways. |
| NetbanxAccountNumber | Account Number for the Netbanx gateway. |
| OrbitalAuthReversal | Indicates whether to perform an authorization reversal when calling VoidTransaction for the Orbital gateway. |
| OrbitalTxRefIdx | Indentifies the unique components of transactions that have been adjusted more than one time for the Orbital gateway. |
| OrbitalVoidAdjustedAmount | Specifies the amount to void from a previous authoization for the Orbital gateway. |
| PayDirectConvenienceFee | The total convenience fee charged when using the PayDirect gateway. |
| PayDirectMerchantAmount | The MerchantAmount used by the PayDirect gateway. |
| PayDirectSettleMerchantCode | The Settle Merchant Code required for authorization when using the PayDirect gateway. |
| PayFlowProInquiry | Submits an Inquiry transaction to the PayFlowPro gateway. |
| PayFlowProToken | Used specify a token to be used instead of card data for the Payflow Pro gateway. |
| PayFlowProUpload | Submits an Upload transaction to the PayFlowPro gateway. |
| PayJunctionUpdateAmount | Indicates whether the capture method should send an update amount request when using the PayJunction gateway. |
| PayPointFreedomAPI | Indicates whether to use the Freedom API for the gwPayPoint and gwSECPay gateways. |
| PayTraceAddPurchaseCardData | Sends a Level3 request for the PayTrace gateway. |
| RecurringIndicator | Marks a request as a recurring transaction. |
| QBMSMobile | Whether or not this transaction is being sent from a mobile device. |
| QBPaymentsMobile | Whether or not this transaction is being sent from a mobile device. |
| SagePayCreateToken | Sends a create token request to the SagePay gateway. |
| SagePayRemoveToken | Sends a remove token request to the SagePay gateway. |
| SagePayRequestToken | Specifies whether to request a token when performing an Auth or Sale when using the SagePay gateway. |
| SagePayStoreToken | Specifies whether to store a token when using the SagePay gateway. |
| SagePayToken | The token value for a corresponding card when using the SagePay gateway. |
| SagePayRepeat | Performs a Repeat transaction for the SagePay gateway. |
| SagePayUseAbort | Indicates whether to use Abort or Void for void transactions. |
| Shift4AuthToken | Specifies the Auth Token when making an Access Token request to the Shift4 gateway. |
| Shift4ClientGuid | Specifies the Client Guid when making an Access Token request to the Shift4 gateway. |
| Shift4GetAccessToken | Performs an Access Token Exchange request with the Shift4 gateway. |
| Shift4InterfaceName | Specifies the name of the interface for the Shift4 gateway. |
| Shift4InterfaceVersion | Specifies the version of the interface for the Shift4 gateway. |
| USAEPayPerformVoidRelease | Specifies whether to perform a void or void:release transaction. |
| AuthNetShipToCompany | The name of the company associated with the customer's shipping address. |
| CardIssueNumber | Special Issue Number used for Switch and Solo cards. |
| CardStartMonth | Used for some international cards. |
| CardStartYear | Used for some international cards. |
| ConvenienceFee | The total convenience fee charged for a transaction. |
| CyberSourceXMLEscape | Determines whether to XML escape the CyberSource gateway request field values. |
| ECI | Electronic Commerce Indicator. |
| HashAlgorithm | Algorithm used for hashing. |
| HashSecret | Security key used to generate a hash for gateways supporting such functionality. |
| MerchantCode | A gateway-supplied merchant number, code, or Id. |
| 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. |
| 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. |
| 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. |
| PayTraceIntegratorId | Used to specify the Integrator Id value assigned by the PayTrace gateway. |
| PayerIP | The IP address of the payer. |
| RawRequest | Returns the data that was sent to the gateway. |
| RawResponse | Returns the data that was received from the gateway. |
| StoreCardOnFile | For the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF). |
| UseCardOnFile | For the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request. |
| ValidateCardNumber | Determines whether data set to the CardNumber or MagneticStripe property is validated. |
| XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
| XText | The text of the current element. |
| XElement | The name of the current element. |
| 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. |
| 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. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| 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. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component 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. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| 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 component 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. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| 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. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| 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. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| 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). |
| 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. |
| SelectWaitMillis | The length of time in milliseconds the component will wait when DoEvents is called if there are no events to process. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |