RecurringBilling Class
Properties Methods Events Config Settings Errors
The RecurringBilling class is used to authorize and set up recurring transactions with any of the supported Internet Payment Gateways.
Class Name
InPay_RecurringBilling
Procedural Interface
inpay_recurringbilling_open(); inpay_recurringbilling_close($res); inpay_recurringbilling_register_callback($res, $id, $function); inpay_recurringbilling_get_last_error($res); inpay_recurringbilling_get_last_error_code($res); inpay_recurringbilling_set($res, $id, $index, $value); inpay_recurringbilling_get($res, $id, $index); inpay_recurringbilling_do_addspecialfield($res, $name, $value); inpay_recurringbilling_do_cancelsubscription($res, $subscriptionid); inpay_recurringbilling_do_config($res, $configurationstring); inpay_recurringbilling_do_createsubscription($res); inpay_recurringbilling_do_doevents($res); inpay_recurringbilling_do_getresponsevar($res, $name); inpay_recurringbilling_do_getsubscriptionstatus($res, $subscriptionid); inpay_recurringbilling_do_interrupt($res); inpay_recurringbilling_do_resetspecialfields($res); inpay_recurringbilling_do_updatesubscription($res, $subscriptionid);
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 Transmission Control Protocol (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 a Secure Sockets Layer (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 | Name of special configuration property to submit in this transaction. |
| SpecialFieldValue | Value of special configuration property to submit in this transaction. |
| SSLAcceptServerCertEncoded | This is the certificate (PEM/base64 encoded). |
| SSLCertEncoded | This is the certificate (PEM/base64 encoded). |
| SSLCertStore | This is the name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SSLCertStoreType | This is the type of certificate store for this certificate. |
| SSLCertSubject | This is the subject of the certificate used for client authentication. |
| SSLProvider | This specifies the SSL/TLS implementation to use. |
| SSLServerCertEncoded | This is 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.
| 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. |
Config Settings
The following is a list of config 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. |
| COFPermission | Indicates if the customer gave permission to make a Card On File transaction. |
| 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. |
| UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
| 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. |
| SSLCheckOCSP | Whether to use OCSP to check the status of 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. |
| SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
| SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
| SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| 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. |
| MaskSensitive | Whether sensitive data is masked in log messages. |
| 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. |
CardType Property (InPay_RecurringBilling Class)
Type of credit card being used in this transaction.
Object Oriented Interface
public function getCardType(); public function setCardType($value);
Procedural Interface
inpay_recurringbilling_get($res, 1 ); inpay_recurringbilling_set($res, 1, $value );
Default Value
0
Remarks
Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.
| ctUnknown (0) | Invalid or unknown prefix, card type not known. |
| ctVisa (1) | Visa or Delta Card. |
| ctMasterCard (2) | MasterCard. |
| ctAMEX (3) | American Express Card. |
| ctDiscover (4) | Discover Card. |
| ctDiners (5) | Diners Club or Carte Blanche Card. |
| ctJCB (6) | JCB Card. |
| ctVisaElectron (7) | Visa Electron Card (runs as a Visa for most gateways) |
| ctMaestro (8) | Maestro Card |
| ctLaser (10) | Laser Card (Ireland) |
This property is not available at design time.
Data Type
Integer
CardCVVData Property (InPay_RecurringBilling Class)
Three digit security code on back of card (optional).
Object Oriented Interface
public function getCardCVVData(); public function setCardCVVData($value);
Procedural Interface
inpay_recurringbilling_get($res, 2 ); inpay_recurringbilling_set($res, 2, $value );
Default Value
''
Remarks
Three digit security code on back of card (optional).
This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.
Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.
Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.
This property is not available at design time.
Data Type
String
CardCVVPresence Property (InPay_RecurringBilling Class)
Indicates the presence of the card verification value.
Object Oriented Interface
public function getCardCVVPresence(); public function setCardCVVPresence($value);
Procedural Interface
inpay_recurringbilling_get($res, 3 ); inpay_recurringbilling_set($res, 3, $value );
Default Value
0
Remarks
Indicates the presence of the card verification value.
This property is used to indicate the presence of CardCVVData.
The class will automatically set this value to cvpProvided when a CardCVVData value is specified. You can explicitly specify the CardCVVPresence indicator by setting this property.
Available values are:
- cvpNotProvided (0)
- cvpProvided (1)
- cvpIllegible (2)
- cvpNotOnCard (3)
This property is not available at design time.
Data Type
Integer
CardEntryDataSource Property (InPay_RecurringBilling Class)
This property contains a 1-character code identifying the source of the customer data.
Object Oriented Interface
public function getCardEntryDataSource(); public function setCardEntryDataSource($value);
Procedural Interface
inpay_recurringbilling_get($res, 4 ); inpay_recurringbilling_set($res, 4, $value );
Default Value
0
Remarks
This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.
| edsTrack1 (0) | Full Magnetic stripe read and transmit, Track 1. |
| edsTrack2 (1) | Full magnetic stripe read and transmit, Track 2. |
| edsManualEntryTrack1Capable (2) | Manually keyed, Track 1 capable. |
| edsManualEntryTrack2Capable (3) | Manually keyed, Track 2 capable. |
| edsManualEntryNoCardReader (4) | Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions). |
| edsTrack2Contactless (6) | Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only). |
| edsManualEntryContactlessCapable (7) | Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only). |
This property is not available at design time.
Data Type
Integer
CardExpMonth Property (InPay_RecurringBilling Class)
Expiration month of the credit card specified in Number .
Object Oriented Interface
public function getCardExpMonth(); public function setCardExpMonth($value);
Procedural Interface
inpay_recurringbilling_get($res, 5 ); inpay_recurringbilling_set($res, 5, $value );
Default Value
1
Remarks
Expiration month of the credit card specified in CardNumber.
This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.
This property is not available at design time.
Data Type
Integer
CardExpYear Property (InPay_RecurringBilling Class)
Expiration year of the credit card specified in Number .
Object Oriented Interface
public function getCardExpYear(); public function setCardExpYear($value);
Procedural Interface
inpay_recurringbilling_get($res, 6 ); inpay_recurringbilling_set($res, 6, $value );
Default Value
2000
Remarks
Expiration year of the credit card specified in CardNumber.
This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.
This property is not available at design time.
Data Type
Integer
CardIsEncrypted Property (InPay_RecurringBilling Class)
Determines whether data set to the Number or MagneticStripe properties is validated.
Object Oriented Interface
public function getCardIsEncrypted(); public function setCardIsEncrypted($value);
Procedural Interface
inpay_recurringbilling_get($res, 7 ); inpay_recurringbilling_set($res, 7, $value );
Default Value
false
Remarks
Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.
By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.
This property is not available at design time.
Data Type
Boolean
CardMagneticStripe Property (InPay_RecurringBilling Class)
Track data read off of the card's magnetic stripe.
Object Oriented Interface
public function getCardMagneticStripe(); public function setCardMagneticStripe($value);
Procedural Interface
inpay_recurringbilling_get($res, 8 ); inpay_recurringbilling_set($res, 8, $value );
Default Value
''
Remarks
Track data read off of the card's magnetic stripe.
If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.
The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"
class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
class.CardEntryDataSource = edsTrack1
or
class.CardMagneticStripe = "4788250000028291=05121015432112345678"
class.CardEntryDataSource = edsTrack2
Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.
This property is not available at design time.
Data Type
String
CardNumber Property (InPay_RecurringBilling Class)
Customer's credit card number for the transaction.
Object Oriented Interface
public function getCardNumber(); public function setCardNumber($value);
Procedural Interface
inpay_recurringbilling_get($res, 9 ); inpay_recurringbilling_set($res, 9, $value );
Default Value
''
Remarks
Customer's credit card number for the transaction.
If you're sending the transaction with CardMagneticStripe data, this property should be left empty.
This property is not available at design time.
Data Type
String
CustomerAddress Property (InPay_RecurringBilling Class)
Customer's street address.
Object Oriented Interface
public function getCustomerAddress(); public function setCustomerAddress($value);
Procedural Interface
inpay_recurringbilling_get($res, 10 ); inpay_recurringbilling_set($res, 10, $value );
Default Value
''
Remarks
Customer's street address. This property is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in This property. City, state, and zip code are set in the CustomerCity, CustomerState, and CustomerZip properties.
The length of this property varies by gateway. If the customer's address is very long, it is admissible to include only the street number in This property.
NOTE: For the Moneris gateway, this property should contain only the customer's street number. The street name should be added via the AddSpecialField method. For example:
class.CustomerAddress = "123"
class.AddSpecialField("avs_street_name", "Nowhere Ln")
This property is not available at design time.
Data Type
String
CustomerAddress2 Property (InPay_RecurringBilling Class)
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.
Object Oriented Interface
public function getCustomerAddress2(); public function setCustomerAddress2($value);
Procedural Interface
inpay_recurringbilling_get($res, 11 ); inpay_recurringbilling_set($res, 11, $value );
Default Value
''
Remarks
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).
This property is not available at design time.
Data Type
String
CustomerAggregate Property (InPay_RecurringBilling Class)
This property allows you to get or set an XML aggregate built from all of the Customer properties.
Object Oriented Interface
public function getCustomerAggregate(); public function setCustomerAggregate($value);
Procedural Interface
inpay_recurringbilling_get($res, 12 ); inpay_recurringbilling_set($res, 12, $value );
Default Value
''
Remarks
This property allows you to get or set an XML aggregate built from all of the Customer properties.
"EPCustomer" is the root element. The Customer properties make up the tags under the root, but
without the beginning "Customer". For instance:
<EPCustomer>
<Address>123 Nowhere Ln.</Address>
<Address2>Apt 3B.</Address2>
<City>Beverly Hills</City>
...
</EPCustomer>
This property is not available at design time.
Data Type
String
CustomerCity Property (InPay_RecurringBilling Class)
Customer's city.
Object Oriented Interface
public function getCustomerCity(); public function setCustomerCity($value);
Procedural Interface
inpay_recurringbilling_get($res, 13 ); inpay_recurringbilling_set($res, 13, $value );
Default Value
''
Remarks
Customer's city. This property is used as part of the Address Verification Service (AVS) and contains the customer's city as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerState, and CustomerZip.
This property is not available at design time.
Data Type
String
CustomerCountry Property (InPay_RecurringBilling Class)
Customer's country.
Object Oriented Interface
public function getCustomerCountry(); public function setCustomerCountry($value);
Procedural Interface
inpay_recurringbilling_get($res, 14 ); inpay_recurringbilling_set($res, 14, $value );
Default Value
''
Remarks
Customer's country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.
Note: If using this property with the PayFuse gateway, this property should contain the ISO-3166 numeric code instead of the standard two-letter code. For example, the ISO code for the US is "840".
This property is not available at design time.
Data Type
String
CustomerEmail Property (InPay_RecurringBilling Class)
Customer's email address.
Object Oriented Interface
public function getCustomerEmail(); public function setCustomerEmail($value);
Procedural Interface
inpay_recurringbilling_get($res, 15 ); inpay_recurringbilling_set($res, 15, $value );
Default Value
''
Remarks
Customer's email address. This optional property contains the customer's email address.
This property is not available at design time.
Data Type
String
CustomerFax Property (InPay_RecurringBilling Class)
Customer's fax number.
Object Oriented Interface
public function getCustomerFax(); public function setCustomerFax($value);
Procedural Interface
inpay_recurringbilling_get($res, 16 ); inpay_recurringbilling_set($res, 16, $value );
Default Value
''
Remarks
Customer's fax number. This optional property contains the customer's fax number.
This property is not available at design time.
Data Type
String
CustomerFirstName Property (InPay_RecurringBilling Class)
Customer's first name.
Object Oriented Interface
public function getCustomerFirstName(); public function setCustomerFirstName($value);
Procedural Interface
inpay_recurringbilling_get($res, 17 ); inpay_recurringbilling_set($res, 17, $value );
Default Value
''
Remarks
Customer's first name. This property contains the customer's first name.
This property is not available at design time.
Data Type
String
CustomerFullName Property (InPay_RecurringBilling Class)
Customer's full name.
Object Oriented Interface
public function getCustomerFullName(); public function setCustomerFullName($value);
Procedural Interface
inpay_recurringbilling_get($res, 18 ); inpay_recurringbilling_set($res, 18, $value );
Default Value
''
Remarks
Customer's full name. This property contains the customer's full name as it appears on the credit card or bank account. Many gateways use this property in addition to, or instead of, the CustomerFirstName and CustomerLastName properties. If a gateway requires a CustomerFullName and the property is empty, CustomerFullName will be constructed using the contents of CustomerFirstName and CustomerLastName.
This property is not available at design time.
Data Type
String
CustomerId Property (InPay_RecurringBilling Class)
Merchant-generated customer Id.
Object Oriented Interface
public function getCustomerId(); public function setCustomerId($value);
Procedural Interface
inpay_recurringbilling_get($res, 19 ); inpay_recurringbilling_set($res, 19, $value );
Default Value
''
Remarks
Merchant-generated customer Id. This property contains a merchant-generated customer identification number. This number should be unique for each different customer that places an order with the merchant.
This property is not available at design time.
Data Type
String
CustomerLastName Property (InPay_RecurringBilling Class)
Customer's last name.
Object Oriented Interface
public function getCustomerLastName(); public function setCustomerLastName($value);
Procedural Interface
inpay_recurringbilling_get($res, 20 ); inpay_recurringbilling_set($res, 20, $value );
Default Value
''
Remarks
Customer's last name. This property contains the customer's last name as it appears on their credit card.
This property is not available at design time.
Data Type
String
CustomerPhone Property (InPay_RecurringBilling Class)
Customer's phone number.
Object Oriented Interface
public function getCustomerPhone(); public function setCustomerPhone($value);
Procedural Interface
inpay_recurringbilling_get($res, 21 ); inpay_recurringbilling_set($res, 21, $value );
Default Value
''
Remarks
Customer's phone number. This optional property contains the customer's phone number.
This property is not available at design time.
Data Type
String
CustomerState Property (InPay_RecurringBilling Class)
Customer's state.
Object Oriented Interface
public function getCustomerState(); public function setCustomerState($value);
Procedural Interface
inpay_recurringbilling_get($res, 22 ); inpay_recurringbilling_set($res, 22, $value );
Default Value
''
Remarks
Customer's state. This property is used as part of the Address Verification Service (AVS) and contains the two character postal abbreviation of the customer's state as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerZip.
This property is not available at design time.
Data Type
String
CustomerZip Property (InPay_RecurringBilling Class)
Customer's zip code (or postal code if outside of the USA).
Object Oriented Interface
public function getCustomerZip(); public function setCustomerZip($value);
Procedural Interface
inpay_recurringbilling_get($res, 23 ); inpay_recurringbilling_set($res, 23, $value );
Default Value
''
Remarks
Customer's zip code (or postal code if outside of the USA). This property is used as part of the Address Verification Service (AVS), and contains the customer's zip code as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerState.
This property is not available at design time.
Data Type
String
BankAccountClass Property (InPay_RecurringBilling Class)
Indicates whether a personal or business account is used for this transaction.
Object Oriented Interface
public function getBankAccountClass(); public function setBankAccountClass($value);
Procedural Interface
inpay_recurringbilling_get($res, 24 ); inpay_recurringbilling_set($res, 24, $value );
Default Value
0
Remarks
Indicates whether a personal or business account is used for this transaction.
Available values:
| Value | Definition |
| acPersonal (0) | Personal Account. |
| acBusiness (1) | Business Account. |
This property is not available at design time.
Data Type
Integer
BankAccountHolderName Property (InPay_RecurringBilling Class)
Account holder's name.
Object Oriented Interface
public function getBankAccountHolderName(); public function setBankAccountHolderName($value);
Procedural Interface
inpay_recurringbilling_get($res, 25 ); inpay_recurringbilling_set($res, 25, $value );
Default Value
''
Remarks
Account holder's name. This property contains the customer's name as it appears on their account. Many gateways use this property in addition to, or instead of, the Customer Firsts and Last name properties. Note that if this property is not specified, the FullName property from the EPCustomer type will be used instead.
This property is not available at design time.
Data Type
String
BankAccountNumber Property (InPay_RecurringBilling Class)
Bank account number for ACH transactions.
Object Oriented Interface
public function getBankAccountNumber(); public function setBankAccountNumber($value);
Procedural Interface
inpay_recurringbilling_get($res, 26 ); inpay_recurringbilling_set($res, 26, $value );
Default Value
''
Remarks
Bank account number for ACH transactions. This property contains the customer's bank account number, which along with the BankRoutingNumber identify the location of the account where funds are to be drawn from for ACH transactions. This property is required for all ACH transactions.
This property is not available at design time.
Data Type
String
BankAccountType Property (InPay_RecurringBilling Class)
Indicates whether a checking or savings account is used for this transaction.
Object Oriented Interface
public function getBankAccountType(); public function setBankAccountType($value);
Procedural Interface
inpay_recurringbilling_get($res, 27 ); inpay_recurringbilling_set($res, 27, $value );
Default Value
0
Remarks
Indicates whether a checking or savings account is used for this transaction. For gateways that support it, this property allows funds to be withdrawn (or added in the case of a Credit) from either the customer's Checking or Savings account.
Available values:
| Value | Definition |
| atChecking (0) | Checking Account. |
| atSavings (1) | Savings Account. |
This property is not available at design time.
Data Type
Integer
BankName Property (InPay_RecurringBilling Class)
Name of the account holder's bank.
Object Oriented Interface
public function getBankName(); public function setBankName($value);
Procedural Interface
inpay_recurringbilling_get($res, 28 ); inpay_recurringbilling_set($res, 28, $value );
Default Value
''
Remarks
Name of the account holder's bank. For example, Citibank, Wells-Fargo, Wachovia, etc. This property contains the name of the bank associated with the BankRoutingNumber.
This property is not available at design time.
Data Type
String
BankRoutingNumber Property (InPay_RecurringBilling Class)
Routing number for ACH transactions.
Object Oriented Interface
public function getBankRoutingNumber(); public function setBankRoutingNumber($value);
Procedural Interface
inpay_recurringbilling_get($res, 29 ); inpay_recurringbilling_set($res, 29, $value );
Default Value
''
Remarks
Routing number for ACH transactions. This property contains the routing number to the customer's bank (Also known as an ABA code). This number indicates at which bank the BankAccountNumber is located, and is used to identify the location of the account where funds are to be drawn from for ACH transactions. This property is required for all ACH transactions.
Note: When using ACHPayments gateway, a leading zero must be added for Canadian bank accounts.
This property is not available at design time.
Data Type
String
ECheckPaymentType Property (InPay_RecurringBilling Class)
The type of check payment request (commonly referred to as SEC Code).
Object Oriented Interface
public function getECheckPaymentType(); public function setECheckPaymentType($value);
Procedural Interface
inpay_recurringbilling_get($res, 30 ); inpay_recurringbilling_set($res, 30, $value );
Default Value
0
Remarks
This property is used to specify the payment type of the check transaction.
Available values:
| Value | Definition |
| ptWEB (0) | Internet Initiated Entry. Transaction was received from consumer via the Internet (ie shopping cart). Web transactions require a drop-down 'I agree' or a standard form of acknowledgment initiated by the customer. |
| ptPPD (1) | Prearranged Payment or Deposit. Credits or Debits that have been pre-arranged by consumers to draft from their personal bank account. Typically used for recurring payments. Signed Authorization by Customer required, or contract language along with voided check. |
| ptTEL (2) | Telephone Initiated Entry. Transaction information was received via the telephone. Transactions Authorization script must be recorded at the time the transaction is processed, or written acknowledgment sent to the customer. |
| ptCCD (3) | Cash Concentration or Disbursement. Used for the transfer of funds between entities. Signed Authorization by Customer required. |
| ptARC (4) | Accounts Receivable Conversion. Used for payments being made against a bill such as a utility. Signed Authorization by Customer required. |
| ptBOC (5) | Back Office Conversion. Paper checks that are collected in a retail environment and then scanned and batched electronically. Customer notification 'Checks are Electronically Processed' required at Point of Sale. |
| ptPOP (6) | Point-of-Purchase. Paper checks that are converted (scanned) into electronic format at the point of sale. The original paper check is voided and returned to the customer. Point of Sale is authorization. |
| ptRCK (7) | Re-Presentation Check. After a check has been return for insufficient funds it may be attempted again using this format. RCK may only be retried once. Customer notification 'Returned Checks are Electronically Re-Processed' required at Point of Sale. |
Data Type
Integer
Gateway Property (InPay_RecurringBilling Class)
Gateway to process transactions with.
Object Oriented Interface
public function getGateway(); public function setGateway($value);
Procedural Interface
inpay_recurringbilling_get($res, 31 ); inpay_recurringbilling_set($res, 31, $value );
Default Value
0
Remarks
This property is used to select the gateway with which transactions will be processed. Setting the Gateway property will also fill the GatewayURL, SpecialFieldName, and SpecialFieldValue properties with default data for the selected gateway. The following table shows the currently supported gateways, as well as the corporate home page for each.
| 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/ |
Data Type
Integer
GatewayURL Property (InPay_RecurringBilling Class)
Default URL for a specific Gateway .
Object Oriented Interface
public function getGatewayURL(); public function setGatewayURL($value);
Procedural Interface
inpay_recurringbilling_get($res, 32 ); inpay_recurringbilling_set($res, 32, $value );
Default Value
''
Remarks
This property is used to change the default URL for a specific Gateway. This is useful for specifying a different URL for testing purposes, or to support additional gateway processors that share a protocol format (such as additional Authorize.net compatible gateways). Please note that the proper "http://" or "https://" formatting must be observed. See "Testing Information" in the Table of Contents for a list of test URLs.
Data Type
String
InvoiceNumber Property (InPay_RecurringBilling Class)
Merchant-generated invoice number.
Object Oriented Interface
public function getInvoiceNumber(); public function setInvoiceNumber($value);
Procedural Interface
inpay_recurringbilling_get($res, 33 ); inpay_recurringbilling_set($res, 33, $value );
Default Value
''
Remarks
This field contains a merchant-generated invoice number. This number should be unique for each transaction. This property is optional for most gateways, but it is recommended that the merchant use an invoice number to keep track of transactions. See the Gateway property to determine if this is a required or optional field for the gateway you are using.
Data Type
String
MerchantLogin Property (InPay_RecurringBilling Class)
Merchant's Gateway login.
Object Oriented Interface
public function getMerchantLogin(); public function setMerchantLogin($value);
Procedural Interface
inpay_recurringbilling_get($res, 34 ); inpay_recurringbilling_set($res, 34, $value );
Default Value
''
Remarks
This is the login Id supplied by the Gateway you signed up with to process credit card transactions.
Data Type
String
MerchantPassword Property (InPay_RecurringBilling Class)
Merchant's Gateway password.
Object Oriented Interface
public function getMerchantPassword(); public function setMerchantPassword($value);
Procedural Interface
inpay_recurringbilling_get($res, 35 ); inpay_recurringbilling_set($res, 35, $value );
Default Value
''
Remarks
This is the password supplied by the Gateway you signed up with to process credit card transactions. Some gateways require passwords only for Credit or Void transactions, some require it for all transactions, and some do not require this field at all.
Data Type
String
PaymentScheduleEndDate Property (InPay_RecurringBilling Class)
The end date of the subscription.
Object Oriented Interface
public function getPaymentScheduleEndDate(); public function setPaymentScheduleEndDate($value);
Procedural Interface
inpay_recurringbilling_get($res, 36 ); inpay_recurringbilling_set($res, 36, $value );
Default Value
''
Remarks
The end date of the subscription.
The default format is "MM/dd/yyyy" and is controlled by DateFormat, or GetSubscriptionStatus.
This property is not available at design time.
Data Type
String
PaymentScheduleFrequency Property (InPay_RecurringBilling Class)
The frequency of payments.
Object Oriented Interface
public function getPaymentScheduleFrequency(); public function setPaymentScheduleFrequency($value);
Procedural Interface
inpay_recurringbilling_get($res, 37 ); inpay_recurringbilling_set($res, 37, $value );
Default Value
''
Remarks
The frequency of payments.
Possible values are:
- "None"
- "Daily"
- "Weekly"
- "BiWeekly"
- "FourWeeks"
- "SemiMonthly"
- "Monthly"
- "BiMonthly"
- "Quarterly"
- "SemiAnnually"
- "Annually"
Gateway specific values not covered by the above values may also be set. Please refer to RecurringBilling Gateway Setup and Required Properties for more information pertaining to gateway specific values.
If PaymentScheduleFrequencyUnit is applicable to the gateway, this property specifies the length of time between charges. This is used in combination with PaymentScheduleFrequencyUnit to specify the frequency of the billing. For instance if PaymentScheduleFrequencyUnit is set to "Days" and PaymentScheduleFrequency is set to "5", payments will occur every 5 days.
This property is not available at design time.
Data Type
String
PaymentScheduleFrequencyUnit Property (InPay_RecurringBilling Class)
The unit of time to be used when calculating the frequency of payments.
Object Oriented Interface
public function getPaymentScheduleFrequencyUnit(); public function setPaymentScheduleFrequencyUnit($value);
Procedural Interface
inpay_recurringbilling_get($res, 38 ); inpay_recurringbilling_set($res, 38, $value );
Default Value
''
Remarks
The unit of time to be used when calculating the frequency of payments.
Possible values are:
- "D" or "Days"
- "M" or "Months"
- "Y" or "Years"
This property is not available at design time.
Data Type
String
PaymentScheduleInitialAmount Property (InPay_RecurringBilling Class)
The initial amount to be charged (such as a trial period or setup fee).
Object Oriented Interface
public function getPaymentScheduleInitialAmount(); public function setPaymentScheduleInitialAmount($value);
Procedural Interface
inpay_recurringbilling_get($res, 39 ); inpay_recurringbilling_set($res, 39, $value );
Default Value
''
Remarks
The initial amount to be charged (such as a trial period or setup fee). This amount can vary from PaymentScheduleRecurAmount.
This property is not available at design time.
Data Type
String
PaymentScheduleRecurAmount Property (InPay_RecurringBilling Class)
The amount to be charged on a recurring basis.
Object Oriented Interface
public function getPaymentScheduleRecurAmount(); public function setPaymentScheduleRecurAmount($value);
Procedural Interface
inpay_recurringbilling_get($res, 40 ); inpay_recurringbilling_set($res, 40, $value );
Default Value
''
Remarks
The amount to be charged on a recurring basis. This amount can vary from PaymentScheduleInitialAmount.
This property is not available at design time.
Data Type
String
PaymentScheduleStartDate Property (InPay_RecurringBilling Class)
The date on which the recurring payments will start processing.
Object Oriented Interface
public function getPaymentScheduleStartDate(); public function setPaymentScheduleStartDate($value);
Procedural Interface
inpay_recurringbilling_get($res, 41 ); inpay_recurringbilling_set($res, 41, $value );
Default Value
''
Remarks
The date on which the recurring payments will start processing.
This property specifies the start date. The default format is "MM/dd/yyyy" and is controlled by DateFormat, or GetSubscriptionStatus.
This property is not available at design time.
Data Type
String
PaymentScheduleTotalPayments Property (InPay_RecurringBilling Class)
The total number of payments.
Object Oriented Interface
public function getPaymentScheduleTotalPayments(); public function setPaymentScheduleTotalPayments($value);
Procedural Interface
inpay_recurringbilling_get($res, 42 ); inpay_recurringbilling_set($res, 42, $value );
Default Value
0
Remarks
The total number of payments. Valid values differ between gateways. See RecurringBilling Gateway Setup and Required Properties for details.
This property is not available at design time.
Data Type
Integer
PaymentScheduleTrialPayments Property (InPay_RecurringBilling Class)
The total number of trial payments.
Object Oriented Interface
public function getPaymentScheduleTrialPayments(); public function setPaymentScheduleTrialPayments($value);
Procedural Interface
inpay_recurringbilling_get($res, 43 ); inpay_recurringbilling_set($res, 43, $value );
Default Value
0
Remarks
The total number of trial payments.
This property is not available at design time.
Data Type
Integer
ProxyAuthScheme Property (InPay_RecurringBilling Class)
This property is used to tell the class which type of authorization to perform when connecting to the proxy.
Object Oriented Interface
public function getProxyAuthScheme(); public function setProxyAuthScheme($value);
Procedural Interface
inpay_recurringbilling_get($res, 44 ); inpay_recurringbilling_set($res, 44, $value );
Default Value
0
Remarks
This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.
If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (InPay_RecurringBilling Class)
This property tells the class whether or not to automatically detect and use proxy system settings, if available.
Object Oriented Interface
public function getProxyAutoDetect(); public function setProxyAutoDetect($value);
Procedural Interface
inpay_recurringbilling_get($res, 45 ); inpay_recurringbilling_set($res, 45, $value );
Default Value
false
Remarks
This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (InPay_RecurringBilling Class)
This property contains a password if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyPassword(); public function setProxyPassword($value);
Procedural Interface
inpay_recurringbilling_get($res, 46 ); inpay_recurringbilling_set($res, 46, $value );
Default Value
''
Remarks
This property contains a password if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (InPay_RecurringBilling Class)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Object Oriented Interface
public function getProxyPort(); public function setProxyPort($value);
Procedural Interface
inpay_recurringbilling_get($res, 47 ); inpay_recurringbilling_set($res, 47, $value );
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (InPay_RecurringBilling Class)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Object Oriented Interface
public function getProxyServer(); public function setProxyServer($value);
Procedural Interface
inpay_recurringbilling_get($res, 48 ); inpay_recurringbilling_set($res, 48, $value );
Default Value
''
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (InPay_RecurringBilling Class)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Object Oriented Interface
public function getProxySSL(); public function setProxySSL($value);
Procedural Interface
inpay_recurringbilling_get($res, 49 ); inpay_recurringbilling_set($res, 49, $value );
Default Value
0
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
| psAutomatic (0) | Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option. |
| psAlways (1) | The connection is always SSL enabled. |
| psNever (2) | The connection is not SSL enabled. |
| psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (InPay_RecurringBilling Class)
This property contains a user name, if authentication is to be used for the proxy.
Object Oriented Interface
public function getProxyUser(); public function setProxyUser($value);
Procedural Interface
inpay_recurringbilling_get($res, 50 ); inpay_recurringbilling_set($res, 50, $value );
Default Value
''
Remarks
This property contains a user name, if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ResponseApprovalCode Property (InPay_RecurringBilling Class)
Contains an authorization code when a transaction has been approved.
Object Oriented Interface
public function getResponseApprovalCode();
Procedural Interface
inpay_recurringbilling_get($res, 51 );
Default Value
''
Remarks
Contains an authorization code when a transaction has been approved. This property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction is not approved, then the contents of this property should be ignored.
This property is read-only and not available at design time.
Data Type
String
ResponseApproved Property (InPay_RecurringBilling Class)
Indicates the status of the last transaction.
Object Oriented Interface
public function getResponseApproved();
Procedural Interface
inpay_recurringbilling_get($res, 52 );
Default Value
false
Remarks
Indicates the status of the last transaction. This property will be True if the last transaction was approved. However, you should not rely solely on the value contained in this property. After every transaction, the ResponseCode should be inspected and evaluated according to the specifications of the Gateway in use. A list of response codes for each gateway is listed in the table of contents. However, it is recommended that the developer acquire the current list from the Gateway which is being used.
This property is read-only and not available at design time.
Data Type
Boolean
ResponseAVSResult Property (InPay_RecurringBilling Class)
Contains the Address Verification System result code.
Object Oriented Interface
public function getResponseAVSResult();
Procedural Interface
inpay_recurringbilling_get($res, 53 );
Default Value
''
Remarks
Contains the Address Verification System result code. This one character property contains the Address Verification Service (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored for later retrieval, as it may be required when voiding or refunding a transaction. Valid AVS response codes are listed below, and are identical across all Gateway (note that some gateways do not return an AVS response).
| ResponseAVSResult | Description |
| A | Address matches, Zip does not. |
| E | AVS error. |
| G | Non-U.S. issuing bank does not support AVS. |
| N | No match on Address or CustomerZip. |
| P | AVS not applicable for this transaction. |
| R | Retry - Issuer system unavailable. |
| S | Service not supported by issuer. |
| U | Address information is unavailable. |
| W | Nine digit Zip matches, Address does not. |
| X | Exact AVS match, nine digit Zip. |
| Y | Exact AVS match, five digit Zip. |
| Z | Five digit Zip matches, Address does not. |
Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.
Adyen
For Adyen, this property will contain the following possible values:
| 0 | Unknown |
| 1 | Address matches, postal code doesn't |
| 2 | Neither postal code nor address match |
| 3 | AVS unavailable |
| 4 | AVS not supported for this card type |
| 5 | No AVS data provided |
| 6 | Postal code matches, address doesn't match |
| 7 | Both postal code and address match |
| 8 | Address not checked, postal code unknown |
| 9 | Address matches, postal code unknown |
| 10 | Address doesn't match, postal code unknown |
| 11 | Postal code not checked, address unknown |
| 12 | Address matches, postal code not checked |
| 13 | Address doesn't match, postal code not checked |
| 14 | Postal code matches, address unknown |
| 15 | Postal code matches, address not checked |
| 16 | Postal code doesn't match, address unknown |
| 17 | Postal code doesn't match, address not checked |
| 18 | Neither postal code nor address were checked |
American Payment Solutions
For American Payment Solutions, this property will contain the following possible values:
| X | Exact match, 9-character numeric ZIP |
| Y, D, or M | Exact match, 5-character numeric ZIP |
| 2 or 6 | Exact match, 5-character numeric ZIP, customer name |
| A or B | Address match only |
| 3 or 7 | Address, customer name match only |
| W | 9-character numeric ZIP match only |
| Z, P, or L | 5-character ZIP match only |
| 1 or 5 | 5-character ZIP, customer name match only |
| N or C | No address or ZIP match only |
| 4 or 8 | No address or ZIP or customer name match only |
| U | Address unavailable |
| G or I | Non-U.S. issuer does not participate |
| R | Issuer system unavailable |
| E | Not a mail/phone order |
| S | Service not supported |
| 0, O, or B | AVS not available |
Barclay
For Barclay, the property will contain the following possible values:
| YY | Address and zip code or postal code match |
| YN | Address matches only |
| NY | Zip code or postal code matches |
| NN | Neither address nor zip code or postal code matches; address is not parsable |
| UU | Address information is unavailable, service is unavailable, or Error; Unknown |
| Blank | No AVS performed |
BlueSnap
For BlueSnap, the property will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following properties:
| 1st Character | Name AVS check |
| 2nd Character | Address AVS check |
| 3rd Character | Postal/Zip Code AVS check |
The possible values for each result character are:
| M | Matches |
| N | Does not match |
| U | Could not be verified |
HSBC
For HSBC, the property will contain the following possible values:
| YY | Address and zip code or postal code match |
| YN | Address matches only |
| NY | Zip code or postal code matches |
| NN | Neither address nor zip code or postal code matches; address is not parsable |
| UU | Address information is unavailable, service is unavailable, or Error; Unknown |
| FF | Issuer does not participate in AVS |
| Blank | No AVS performed |
PayTrace / PayTraceJSON
For PayTrace / PayTraceJSON, the property will contain the following possible values:
| Full Exact Match | |
| Address Match Only | |
| Zip Match Only | |
| No Match | |
| Address Unavailable | |
| Non-US Issuer does not participate | |
| Issuer System Unavailable | |
| Not a Mail/Phone Order | |
| Service Not Supported |
QBMS
For the QBMS gateway, the ResponseAVSResult property will contain the result for the street address, a comma, and then the result for the zip code. The values returned are "Pass", "Fail", and "NotAvailable". Therefore, an ResponseAVSResult of "Fail,Pass" means that the street address failed validation, but the zip code passed.
DataCash
For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):
| NO DATA MATCHES | |
| ADDRESS MATCH ONLY | |
| SECURITY CODE MATCH ONLY | |
| ALL MATCH | |
| DATA NOT CHECKED |
Stripe
For Stripe, the property will contain the following possible values:
| Pass | The first address line or zip code provided is correct. |
| Fail | The first address line or zip code provided is incorrect. |
| Unavailable | The customer's bank did not check the first address line or zip code provided. |
| Unchecked | The first address line or zip code was provided but has not yet been checked. |
Worldpay
For Worldpay, the property will contain a 4-character string, which contains the AVS checks for the following properties:
| 1st Character | Card Verification Value (CVV) check |
| 2nd Character | Postal/Zip Code AVS check |
| 3rd Character | Address AVS check |
| 4th Character | Country Comparison check |
The possible values for each result character are:
| 0 | Not Supported. |
| 1 | Not Checked. |
| 2 | Matched. |
| 4 | No Match. |
| 8 | Partial Match. |
Worldpay Online
For Worldpay Online, the property will contain one of the following:
| Value | Description |
| APPROVED | The supplied street and postal code details fully matched the payment provider's records |
| PARTIAL APPROVED | One of the supplied street or postal code details did not match the payment provider's records |
| NOT SENT TO ACQUIRER | Problem with acquirer - possibly no AVS support |
| NO RESPONSE FROM ACQUIRER | Problem with acquirer - possibly no AVS support |
| NOT CHECKED BY ACQUIRER | The acquirer did not check the address details |
| NOT SUPPLIED BY SHOPPER | Missing, incomplete or invalid address details in the order prevented the address from being checked |
| FAILED | Both street and postal code details did not match the payment provider's records |
This property is read-only and not available at design time.
Data Type
String
ResponseCode Property (InPay_RecurringBilling Class)
Indicates the status of the authorization request.
Object Oriented Interface
public function getResponseCode();
Procedural Interface
inpay_recurringbilling_get($res, 54 );
Default Value
''
Remarks
Indicates the status of the authorization request. This property contains the actual response code as returned by the Gateway. Unlike the ResponseApproved property, this ResponseCode property may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the ResponseCode as well as the ResponseApproved property. The Point of Sale system should evaluate this response code and NOT the ResponseText to determine nature of a response message. The current (at the time of this release) response codes for the supported Gateways are listed in the table of contents to your left.
This property is read-only and not available at design time.
Data Type
String
ResponseCVVResult Property (InPay_RecurringBilling Class)
Contains the returned CVV2 result code if it was requested.
Object Oriented Interface
public function getResponseCVVResult();
Procedural Interface
inpay_recurringbilling_get($res, 55 );
Default Value
''
Remarks
Contains the returned CVV2 result code if it was requested. This property contains the host returned CVV2 result code (if CVV data was sent in the request). The following is a list of current result codes:
| M | CVV2 Match. |
| N | CVV2 No Match. |
| P | Not Processed. |
| S | Merchant has indicated that CVV2 is not present on card. |
| U | Issuer not certified and/or has not provided Visa encryption keys. |
Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.
HSBC
For HSBC, the property will contain:
| 0 | Card type does not support CVM |
| 1 | CVM match |
| 2 | CVM did not match issuer value |
| 3 | CVM was not processed |
| 4 | CVM should be on the card but cardholder indicated otherwise |
| 5 | CVM not supported by issuer |
| 6 | Not valid |
| 7 | No response from server |
Adyen
For Adyen, the property will contain:
| 0 | Unknown |
| 1 | Matches |
| 2 | Does not match |
| 3 | Not checked |
| 4 | No CVC/CVV provided, but was required |
| 5 | Issuer not certified for CVC/CVV |
| 6 | No CVC/CVV provided |
Barclay
For Barclay, the property will contain:
| 0,1 | CVM was not processed |
| 2 | CVM match |
| 4 | CVM does not match issuer value |
| Unknown | CVM invalid or missing |
| Blank | No response from server |
BlueSnap
For BlueSnap, the property will contain:
| MA | Match |
| NC | Issuer is not certified for CVV2/CVC2/CID |
| ND | Check was not done |
| NM | No match |
| NP | CVV2/CVC2/CID should be on the card but is not present |
| NR | CVV check not requested |
DataCash
For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):
| NO DATA MATCHES | |
| ADDRESS MATCH ONLY | |
| SECURITY CODE MATCH ONLY | |
| ALL MATCH | |
| DATA NOT CHECKED |
Stripe
For Stripe, the property will contain the following possible values:
| Pass | The CVC provided is correct. |
| Fail | The CVC provided is incorrect. |
| Unavailable | The customer's bank did not check the CVC provided. |
| Unchecked | The CVC was provided but has not yet been checked. |
Worldpay Online
For Worldpay Online, the property will contain one of the following:
| Value | Description |
| APPROVED | The supplied CVC details matched the payment provider's records |
| NOT SENT TO ACQUIRER | Problem with acquirer - possibly no CVC support |
| NO RESPONSE FROM ACQUIRER | Problem with acquirer - possibly no CVC support |
| NOT CHECKED BY ACQUIRER | The acquirer did not check the CVC details |
| NOT SUPPLIED BY SHOPPER | Missing, or invalid CVC in the payment details prevented the CVC from being checked |
| FAILED | The supplied CVC did not match the payment provider's records |
This property is read-only and not available at design time.
Data Type
String
ResponseData Property (InPay_RecurringBilling Class)
The entire response returned from the gateway processor.
Object Oriented Interface
public function getResponseData();
Procedural Interface
inpay_recurringbilling_get($res, 56 );
Default Value
''
Remarks
The entire response returned from the gateway processor. This property contains the entire response returned from the gateway processor. You may use this to parse additional information that is not returned in the standard response properties.
This property is read-only and not available at design time.
Data Type
String
ResponseErrorCode Property (InPay_RecurringBilling Class)
Additional error code returned by some gateways.
Object Oriented Interface
public function getResponseErrorCode();
Procedural Interface
inpay_recurringbilling_get($res, 57 );
Default Value
''
Remarks
Additional error code returned by some gateways. If a gateway returns it, this property will contain an additional code that may explain why the transaction was declined. You may also wish to inspect ResponseErrorText for a human-readable description of this ResponseErrorCode.
This property is read-only and not available at design time.
Data Type
String
ResponseErrorText Property (InPay_RecurringBilling Class)
Additional error description returned by some gateways.
Object Oriented Interface
public function getResponseErrorText();
Procedural Interface
inpay_recurringbilling_get($res, 58 );
Default Value
''
Remarks
Additional error description returned by some gateways. If a gateway returns it, this property will contain a human-readable description of the error which occurred (if any). You may also wish to inspect ResponseErrorCode for an accompanying code which may be parsed and used by your application.
This property is read-only and not available at design time.
Data Type
String
ResponseInvoiceNumber Property (InPay_RecurringBilling Class)
Invoice number submitted in authorization request (if applicable).
Object Oriented Interface
public function getResponseInvoiceNumber();
Procedural Interface
inpay_recurringbilling_get($res, 59 );
Default Value
''
Remarks
Invoice number submitted in authorization request (if applicable). This property contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.
This property is read-only and not available at design time.
Data Type
String
ResponseProcessorCode Property (InPay_RecurringBilling Class)
Response code from the underlying processor.
Object Oriented Interface
public function getResponseProcessorCode();
Procedural Interface
inpay_recurringbilling_get($res, 60 );
Default Value
''
Remarks
Response code from the underlying processor. Often times a Gateway will return a ResponseCode that indicates only whether the transaction is approved or declined. Many of these also include a secondary code that provides more details as to why the transaction was declined.
Note, for the PayFlowPro Gateway this property will contain a "1" if the transaction was a duplicate, a "-1" if duplicate checking service is unavailable, and will be blank for a successfully authorized transaction.
This property is read-only and not available at design time.
Data Type
String
ResponseSubscriptionId Property (InPay_RecurringBilling Class)
Contains the Subscription or Profile Identifier for the recurring payment.
Object Oriented Interface
public function getResponseSubscriptionId();
Procedural Interface
inpay_recurringbilling_get($res, 61 );
Default Value
''
Remarks
Contains the Subscription or Profile Identifier for the recurring payment. This property contains a subscription identifier or profile number used to reference a recurring payment. This property is used when performing subsequent actions on a recurring payment.
This property is read-only and not available at design time.
Data Type
String
ResponseText Property (InPay_RecurringBilling Class)
Text information that describes each response code.
Object Oriented Interface
public function getResponseText();
Procedural Interface
inpay_recurringbilling_get($res, 62 );
Default Value
''
Remarks
Text information that describes each response code. This property contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. A Gateway may translate the response according to the language indicated in the merchant account setup (if applicable).
This property is read-only and not available at design time.
Data Type
String
ResponseTransactionId Property (InPay_RecurringBilling Class)
Contains the Visa Transaction Identifier or MasterCard Reference Number.
Object Oriented Interface
public function getResponseTransactionId();
Procedural Interface
inpay_recurringbilling_get($res, 63 );
Default Value
''
Remarks
Contains the Visa Transaction Identifier or MasterCard Reference Number. This property contains a transaction identifier or reference number. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and used to submit a modification of this transaction at a later time (such as voiding the transaction or capturing an authorization-only transaction, if applicable).
This property is read-only and not available at design time.
Data Type
String
ShippingAddress Property (InPay_RecurringBilling Class)
Customer's shipping street address.
Object Oriented Interface
public function getShippingAddress(); public function setShippingAddress($value);
Procedural Interface
inpay_recurringbilling_get($res, 64 ); inpay_recurringbilling_set($res, 64, $value );
Default Value
''
Remarks
Customer's shipping street address.
This property is not available at design time.
Data Type
String
ShippingAddress2 Property (InPay_RecurringBilling Class)
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.
Object Oriented Interface
public function getShippingAddress2(); public function setShippingAddress2($value);
Procedural Interface
inpay_recurringbilling_get($res, 65 ); inpay_recurringbilling_set($res, 65, $value );
Default Value
''
Remarks
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).
This property is not available at design time.
Data Type
String
ShippingCity Property (InPay_RecurringBilling Class)
Customer's shipping city.
Object Oriented Interface
public function getShippingCity(); public function setShippingCity($value);
Procedural Interface
inpay_recurringbilling_get($res, 66 ); inpay_recurringbilling_set($res, 66, $value );
Default Value
''
Remarks
Customer's shipping city.
This property is not available at design time.
Data Type
String
ShippingCountry Property (InPay_RecurringBilling Class)
Customer's shipping country.
Object Oriented Interface
public function getShippingCountry(); public function setShippingCountry($value);
Procedural Interface
inpay_recurringbilling_get($res, 67 ); inpay_recurringbilling_set($res, 67, $value );
Default Value
''
Remarks
Customer's shipping country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.
This property is not available at design time.
Data Type
String
ShippingEmail Property (InPay_RecurringBilling Class)
Customer's email address.
Object Oriented Interface
public function getShippingEmail(); public function setShippingEmail($value);
Procedural Interface
inpay_recurringbilling_get($res, 68 ); inpay_recurringbilling_set($res, 68, $value );
Default Value
''
Remarks
Customer's email address.
This property is not available at design time.
Data Type
String
ShippingFirstName Property (InPay_RecurringBilling Class)
Customer's first name.
Object Oriented Interface
public function getShippingFirstName(); public function setShippingFirstName($value);
Procedural Interface
inpay_recurringbilling_get($res, 69 ); inpay_recurringbilling_set($res, 69, $value );
Default Value
''
Remarks
Customer's first name.
This property is not available at design time.
Data Type
String
ShippingLastName Property (InPay_RecurringBilling Class)
Customer's last name.
Object Oriented Interface
public function getShippingLastName(); public function setShippingLastName($value);
Procedural Interface
inpay_recurringbilling_get($res, 70 ); inpay_recurringbilling_set($res, 70, $value );
Default Value
''
Remarks
Customer's last name.
This property is not available at design time.
Data Type
String
ShippingPhone Property (InPay_RecurringBilling Class)
Customer's phone number.
Object Oriented Interface
public function getShippingPhone(); public function setShippingPhone($value);
Procedural Interface
inpay_recurringbilling_get($res, 71 ); inpay_recurringbilling_set($res, 71, $value );
Default Value
''
Remarks
Customer's phone number.
This property is not available at design time.
Data Type
String
ShippingState Property (InPay_RecurringBilling Class)
Customer's shipping state.
Object Oriented Interface
public function getShippingState(); public function setShippingState($value);
Procedural Interface
inpay_recurringbilling_get($res, 72 ); inpay_recurringbilling_set($res, 72, $value );
Default Value
''
Remarks
Customer's shipping state.
This property is not available at design time.
Data Type
String
ShippingZip Property (InPay_RecurringBilling Class)
Customer's shipping zip code (or postal code if outside of the USA).
Object Oriented Interface
public function getShippingZip(); public function setShippingZip($value);
Procedural Interface
inpay_recurringbilling_get($res, 73 ); inpay_recurringbilling_set($res, 73, $value );
Default Value
''
Remarks
Customer's shipping zip code (or postal code if outside of the USA).
This property is not available at design time.
Data Type
String
SpecialFieldCount Property (InPay_RecurringBilling Class)
The number of records in the SpecialField arrays.
Object Oriented Interface
public function getSpecialFieldCount(); public function setSpecialFieldCount($value);
Procedural Interface
inpay_recurringbilling_get($res, 74 ); inpay_recurringbilling_set($res, 74, $value );
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at SpecialFieldCount - 1.This property is not available at design time.
Data Type
Integer
SpecialFieldName Property (InPay_RecurringBilling Class)
Name of special configuration property to submit in this transaction.
Object Oriented Interface
public function getSpecialFieldName($fieldindex); public function setSpecialFieldName($fieldindex, $value);
Procedural Interface
inpay_recurringbilling_get($res, 75 , $fieldindex); inpay_recurringbilling_set($res, 75, $value , $fieldindex);
Default Value
''
Remarks
Name of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.
This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.
The $fieldindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.
This property is not available at design time.
Data Type
String
SpecialFieldValue Property (InPay_RecurringBilling Class)
Value of special configuration property to submit in this transaction.
Object Oriented Interface
public function getSpecialFieldValue($fieldindex); public function setSpecialFieldValue($fieldindex, $value);
Procedural Interface
inpay_recurringbilling_get($res, 76 , $fieldindex); inpay_recurringbilling_set($res, 76, $value , $fieldindex);
Default Value
''
Remarks
Value of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.
Note: This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.
The $fieldindex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.
This property is not available at design time.
Data Type
String
SSLAcceptServerCertEncoded Property (InPay_RecurringBilling Class)
This is the certificate (PEM/base64 encoded).
Object Oriented Interface
public function getSSLAcceptServerCertEncoded(); public function setSSLAcceptServerCertEncoded($value);
Procedural Interface
inpay_recurringbilling_get($res, 78 ); inpay_recurringbilling_set($res, 78, $value );
Default Value
''
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.
When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertEncoded Property (InPay_RecurringBilling Class)
This is the certificate (PEM/base64 encoded).
Object Oriented Interface
public function getSSLCertEncoded(); public function setSSLCertEncoded($value);
Procedural Interface
inpay_recurringbilling_get($res, 106 ); inpay_recurringbilling_set($res, 106, $value );
Default Value
''
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (InPay_RecurringBilling Class)
This is the name of the certificate store for the client certificate.
Object Oriented Interface
public function getSSLCertStore(); public function setSSLCertStore($value);
Procedural Interface
inpay_recurringbilling_get($res, 122 ); inpay_recurringbilling_set($res, 122, $value );
Default Value
'MY'
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (InPay_RecurringBilling Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Object Oriented Interface
public function getSSLCertStorePassword(); public function setSSLCertStorePassword($value);
Procedural Interface
inpay_recurringbilling_get($res, 123 ); inpay_recurringbilling_set($res, 123, $value );
Default Value
''
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (InPay_RecurringBilling Class)
This is the type of certificate store for this certificate.
Object Oriented Interface
public function getSSLCertStoreType(); public function setSSLCertStoreType($value);
Procedural Interface
inpay_recurringbilling_get($res, 124 ); inpay_recurringbilling_set($res, 124, $value );
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS11 interface.
To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (InPay_RecurringBilling Class)
This is the subject of the certificate used for client authentication.
Object Oriented Interface
public function getSSLCertSubject(); public function setSSLCertSubject($value);
Procedural Interface
inpay_recurringbilling_get($res, 125 ); inpay_recurringbilling_set($res, 125, $value );
Default Value
''
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma it must be quoted.
Data Type
String
SSLProvider Property (InPay_RecurringBilling Class)
This specifies the SSL/TLS implementation to use.
Object Oriented Interface
public function getSSLProvider(); public function setSSLProvider($value);
Procedural Interface
inpay_recurringbilling_get($res, 133 ); inpay_recurringbilling_set($res, 133, $value );
Default Value
0
Remarks
This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are:
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
Data Type
Integer
SSLServerCertEncoded Property (InPay_RecurringBilling Class)
This is the certificate (PEM/base64 encoded).
Object Oriented Interface
public function getSSLServerCertEncoded();
Procedural Interface
inpay_recurringbilling_get($res, 135 );
Default Value
''
Remarks
This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.
When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.
This property is read-only and not available at design time.
Data Type
Binary String
SubscriptionDesc Property (InPay_RecurringBilling Class)
Description of recurring subscription.
Object Oriented Interface
public function getSubscriptionDesc(); public function setSubscriptionDesc($value);
Procedural Interface
inpay_recurringbilling_get($res, 162 ); inpay_recurringbilling_set($res, 162, $value );
Default Value
''
Remarks
This field contains a description of the recurring subscription. Please see the RecurringBilling Gateway Setup and Required Properties page to determine if this is a required or optional field for the gateway you are using.
Data Type
String
SubscriptionDetailsCardExpMonth Property (InPay_RecurringBilling Class)
The expiration month of the card currently being processed for the recurring payments.
Object Oriented Interface
public function getSubscriptionDetailsCardExpMonth();
Procedural Interface
inpay_recurringbilling_get($res, 163 );
Default Value
0
Remarks
The expiration month of the card currently being processed for the recurring payments.
This property is read-only and not available at design time.
Data Type
Integer
SubscriptionDetailsCardExpYear Property (InPay_RecurringBilling Class)
The expiration year of the card currently being processed for the recurring payments.
Object Oriented Interface
public function getSubscriptionDetailsCardExpYear();
Procedural Interface
inpay_recurringbilling_get($res, 164 );
Default Value
0
Remarks
The expiration year of the card currently being processed for the recurring payments.
This property is read-only and not available at design time.
Data Type
Integer
SubscriptionDetailsCardNumber Property (InPay_RecurringBilling Class)
The card number currently being processed for the recurring payments.
Object Oriented Interface
public function getSubscriptionDetailsCardNumber();
Procedural Interface
inpay_recurringbilling_get($res, 165 );
Default Value
''
Remarks
The card number currently being processed for the recurring payments.
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsEndDate Property (InPay_RecurringBilling Class)
The date in which the recurring payments will stop processing.
Object Oriented Interface
public function getSubscriptionDetailsEndDate();
Procedural Interface
inpay_recurringbilling_get($res, 166 );
Default Value
''
Remarks
The date in which the recurring payments will stop processing.
The date is returned in the format specified within the DateFormat config.
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsFrequency Property (InPay_RecurringBilling Class)
The frequency in which payments will occur.
Object Oriented Interface
public function getSubscriptionDetailsFrequency();
Procedural Interface
inpay_recurringbilling_get($res, 167 );
Default Value
''
Remarks
The frequency in which payments will occur.
If SubscriptionDetailsFrequencyUnit is applicable, this property will contain the length of the corresponding SubscriptionDetailsFrequencyUnit in which payments will occur.
This component uses pre-defined Frequency values which are listed below. If a gateway returns any value not contained within the pre-defined list, the raw value will be returned.
- None
- Daily
- Weekly
- BiWeekly
- FourWeeks
- SemiMonthly
- Monthly
- BiMonthly
- Quarterly
- SemiAnnually
- Annually
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsFrequencyUnit Property (InPay_RecurringBilling Class)
The unit frequency in which the payments will be processed.
Object Oriented Interface
public function getSubscriptionDetailsFrequencyUnit();
Procedural Interface
inpay_recurringbilling_get($res, 168 );
Default Value
''
Remarks
The unit frequency in which the payments will be processed.
This component uses pre-defined FrequencyUnit values which are listed below. If a gateway returns any value not contained within the pre-defined list, the raw value will be returned.
- Days
- Weeks
- Months
- Years
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsLastPaymentDate Property (InPay_RecurringBilling Class)
The date that the last/previous transaction was processed.
Object Oriented Interface
public function getSubscriptionDetailsLastPaymentDate();
Procedural Interface
inpay_recurringbilling_get($res, 169 );
Default Value
''
Remarks
The date that the last/previous transaction was processed.
The date is returned in the format specified within the DateFormat config.
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsNextPaymentDate Property (InPay_RecurringBilling Class)
The date of the next upcoming transaction.
Object Oriented Interface
public function getSubscriptionDetailsNextPaymentDate();
Procedural Interface
inpay_recurringbilling_get($res, 170 );
Default Value
''
Remarks
The date of the next upcoming transaction.
The date is returned in the format specified within the DateFormat config.
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsRecurAmount Property (InPay_RecurringBilling Class)
The amount being charged on a recurring basis.
Object Oriented Interface
public function getSubscriptionDetailsRecurAmount();
Procedural Interface
inpay_recurringbilling_get($res, 171 );
Default Value
''
Remarks
The amount being charged on a recurring basis.
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsRemainingPayments Property (InPay_RecurringBilling Class)
The total number of remaining payments until the recurring payments will stop processing.
Object Oriented Interface
public function getSubscriptionDetailsRemainingPayments();
Procedural Interface
inpay_recurringbilling_get($res, 172 );
Default Value
0
Remarks
The total number of remaining payments until the recurring payments will stop processing.
This property is read-only and not available at design time.
Data Type
Integer
SubscriptionDetailsStartDate Property (InPay_RecurringBilling Class)
The date in which the recurring payments started processing.
Object Oriented Interface
public function getSubscriptionDetailsStartDate();
Procedural Interface
inpay_recurringbilling_get($res, 173 );
Default Value
''
Remarks
The date in which the recurring payments started processing.
The date is returned in the format specified within the DateFormat config.
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsStatus Property (InPay_RecurringBilling Class)
The current status of the recurring subscription.
Object Oriented Interface
public function getSubscriptionDetailsStatus();
Procedural Interface
inpay_recurringbilling_get($res, 174 );
Default Value
''
Remarks
The current status of the recurring subscription.
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsSubscriptionId Property (InPay_RecurringBilling Class)
Contains the Subscription or Profile Identifier for the recurring payment.
Object Oriented Interface
public function getSubscriptionDetailsSubscriptionId();
Procedural Interface
inpay_recurringbilling_get($res, 175 );
Default Value
''
Remarks
Contains the Subscription or Profile Identifier for the recurring payment.
This property contains a subscription identifier or profile number used to reference a recurring payment.
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsSubscriptionName Property (InPay_RecurringBilling Class)
Contains the name of the recurring subscription or profile.
Object Oriented Interface
public function getSubscriptionDetailsSubscriptionName();
Procedural Interface
inpay_recurringbilling_get($res, 176 );
Default Value
''
Remarks
Contains the name of the recurring subscription or profile.
This property is read-only and not available at design time.
Data Type
String
SubscriptionDetailsTotalPayments Property (InPay_RecurringBilling Class)
The total number of payments.
Object Oriented Interface
public function getSubscriptionDetailsTotalPayments();
Procedural Interface
inpay_recurringbilling_get($res, 177 );
Default Value
0
Remarks
The total number of payments.
This property is read-only and not available at design time.
Data Type
Integer
SubscriptionName Property (InPay_RecurringBilling Class)
The name of the recurring subscription or profile.
Object Oriented Interface
public function getSubscriptionName(); public function setSubscriptionName($value);
Procedural Interface
inpay_recurringbilling_get($res, 178 ); inpay_recurringbilling_set($res, 178, $value );
Default Value
''
Remarks
This field contains the name of the recurring subscription or profile. Please see the RecurringBilling Gateway Setup and Required Properties page to determine if this is a required or optional field for the gateway you are using.
Data Type
String
TestMode Property (InPay_RecurringBilling Class)
Turns test mode on and off for transactions sent to the current Gateway .
Object Oriented Interface
public function getTestMode(); public function setTestMode($value);
Procedural Interface
inpay_recurringbilling_get($res, 179 ); inpay_recurringbilling_set($res, 179, $value );
Default Value
false
Remarks
You can use this property to set a test mode flag that will be sent in an authorization request. Not all Gateways support test modes. If you set the TestMode property to True and the current Gateway does not support it, the class will fails with an error.
Data Type
Boolean
Timeout Property (InPay_RecurringBilling Class)
A timeout for the class.
Object Oriented Interface
public function getTimeout(); public function setTimeout($value);
Procedural Interface
inpay_recurringbilling_get($res, 180 ); inpay_recurringbilling_set($res, 180, $value );
Default Value
30
Remarks
If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.
The default value for Timeout is 30 (seconds).
Data Type
Integer
TransactionId Property (InPay_RecurringBilling Class)
Merchant-generated transaction Id used for all transactions.
Object Oriented Interface
public function getTransactionId(); public function setTransactionId($value);
Procedural Interface
inpay_recurringbilling_get($res, 181 ); inpay_recurringbilling_set($res, 181, $value );
Default Value
''
Remarks
This property is used to send a merchant-generated transaction id to the Gateway, if the gateway supports that feature.
Data Type
String
AddSpecialField Method (InPay_RecurringBilling Class)
Adds a special field name and the corresponding value.
Object Oriented Interface
public function doAddSpecialField($name, $value);
Procedural Interface
inpay_recurringbilling_do_addspecialfield($res, $name, $value);
Remarks
Please refer to the SpecialFieldName and SpecialFieldValue properties for more information on form variables and how they are managed.
CancelSubscription Method (InPay_RecurringBilling Class)
Cancels or deletes a recurring payment subscription.
Object Oriented Interface
public function doCancelSubscription($subscriptionid);
Procedural Interface
inpay_recurringbilling_do_cancelsubscription($res, $subscriptionid);
Remarks
This method is used to cancel or delete a recurring subscription identified by the specified SubscriptionId.
Config Method (InPay_RecurringBilling Class)
Sets or retrieves a configuration setting.
Object Oriented Interface
public function doConfig($configurationstring);
Procedural Interface
inpay_recurringbilling_do_config($res, $configurationstring);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
CreateSubscription Method (InPay_RecurringBilling Class)
Creates a new recurring subscription.
Object Oriented Interface
public function doCreateSubscription();
Procedural Interface
inpay_recurringbilling_do_createsubscription($res);
Remarks
This method is used to create a recurring subscription based upon the payment details entered via PaymentSchedule.
DoEvents Method (InPay_RecurringBilling Class)
Processes events from the internal message queue.
Object Oriented Interface
public function doEvents();
Procedural Interface
inpay_recurringbilling_do_doevents($res);
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
GetResponseVar Method (InPay_RecurringBilling Class)
Parses additional information out of the response.
Object Oriented Interface
public function doGetResponseVar($name);
Procedural Interface
inpay_recurringbilling_do_getresponsevar($res, $name);
Remarks
Due to the fact that this class supports so many gateways, only the most commonly used response variables are parsed into the Response properties. Any additional response information contained within the ResponseData may be retrieved with this GetResponseVar method. There are three formats for the ResponseData returned by the gateways this class supports: Name/value pairs, delimited list, or XML. The value you pass in the Name parameter changes based on these formats, as detailed below:
If the ResponseData property contains name/value pairs, pass the name in the Name parameter and this method will return the value. For instance, if ResponseData contains "ResponseCode=00&FraudScore=53&ApprovalCode=123456&...", calling GetResponseVar("FraudScore") will return "53".
However, if ResponseData contains a delimited list, pass the index of the field you wish to receive. For instance, if ResponseData contains "00|53|123456|...", calling GetResponseVar("1") will return "53".
Finally, if ResponseData contains XML, pass the xpath to the value you wish to receive. For instance, if ResponseData contains "<Response><Code>00</Code><FraudScore>53</FraudScore><ApprovalCode>123456</ApprovalCode></Response>", calling GetResponseVar("/Response/FraudScore") will return "53".
GetSubscriptionStatus Method (InPay_RecurringBilling Class)
Retrieves the status of a recurring payment subscription.
Object Oriented Interface
public function doGetSubscriptionStatus($subscriptionid);
Procedural Interface
inpay_recurringbilling_do_getsubscriptionstatus($res, $subscriptionid);
Remarks
This method retrieves the current status of the recurring payment subscription specified via SubscriptionId. SubscriptionDetails will be populated with the details about the subscription.
Interrupt Method (InPay_RecurringBilling Class)
Interrupts the current action.
Object Oriented Interface
public function doInterrupt();
Procedural Interface
inpay_recurringbilling_do_interrupt($res);
Remarks
This method interrupts any processing that the class is currently executing.
ResetSpecialFields Method (InPay_RecurringBilling Class)
Resets all special fields to the default settings.
Object Oriented Interface
public function doResetSpecialFields();
Procedural Interface
inpay_recurringbilling_do_resetspecialfields($res);
Remarks
This function resets all special gateway configuration fields to the default settings for the specified Gateway.
Please refer to the SpecialFieldName and SpecialFieldValue properties for more information on form variables and how they are managed.
UpdateSubscription Method (InPay_RecurringBilling Class)
Updates a recurring payment subscription.
Object Oriented Interface
public function doUpdateSubscription($subscriptionid);
Procedural Interface
inpay_recurringbilling_do_updatesubscription($res, $subscriptionid);
Remarks
This method is used to update a recurring subscription, specified by SubscriptionId. Specify new values via PaymentSchedule before calling this method.
Error Event (InPay_RecurringBilling Class)
Information about errors during data delivery.
Object Oriented Interface
public function fireError($param);
Procedural Interface
inpay_recurringbilling_register_callback($res, 1, array($this, 'fireError'));
Parameter List
'errorcode'
'description'
Remarks
The Error event is fired in case of exceptional conditions during message processing.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
SSLServerAuthentication Event (InPay_RecurringBilling Class)
Fired after the server presents its certificate to the client.
Object Oriented Interface
public function fireSSLServerAuthentication($param);
Procedural Interface
inpay_recurringbilling_register_callback($res, 2, array($this, 'fireSSLServerAuthentication'));
Parameter List
'certencoded'
'certsubject'
'certissuer'
'status'
'accept'
Remarks
This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (InPay_RecurringBilling Class)
Shows the progress of the secure connection.
Object Oriented Interface
public function fireSSLStatus($param);
Procedural Interface
inpay_recurringbilling_register_callback($res, 3, array($this, 'fireSSLStatus'));
Parameter List
'message'
Remarks
The event is fired for informational and logging purposes only. Used to track the progress of the connection.
Config Settings (RecurringBilling Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.RecurringBilling Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3DSECI: Electronic Commerce Indicator.This contains a 1-character transaction indicator identifying the type of transaction being authorized. Supported values vary between gateways, so please consult gateway documentation for more information. Note: Other values necessary for passing 3D Secure data are 3DSXID and 3DSCAVV. This setting is only valid for E-Commerce transactions. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
AmountFormat:
Used to set the input format for TransactionAmount.This configuration setting can be used to specify a single input format for the PaymentScheduleInitialAmount
and PaymentScheduleRecurAmount. When set to a value other than 0, the class will automatically convert
the amount from the specified format to the format expected by the gateway. Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMGuestProfile: Specifies whether a profile is a guest profile or a normal profile.If this configuration setting is set to True when creating a customer profile (default False), the profile will be created as a guest profile. A guest profile will be deleted automatically after 90 days of inactivity. This setting can also be checked after getting the status of a customer profile to tell if it is a guest profile. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMMaskedCardNumber:
The masked card number returned for the payment profile at the specified index.This config holds the masked card number that is stored in the payment profile selected by AuthNetCIMPaymentProfileIndex.
When updating a payment profile, this masked card number will be re-submitted if real card information is not specified, which prevents Authorize.Net from changing the card information on file. This makes it possible to update just the billing information associated with a payment profile without affecting the stored card information. This configuration setting can also be used when updating a subscription with the Authorize.NET gateway. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMPaymentProfileCount: The number of Payment Profiles assigned to a customer profile within the Authorize.NET CIM gateway.This config is populated after a GetSubscriptionStatus call for a Profile (AuthNetCIMRequestType set to '0') and contains the total number of Payment Profiles assigned to the specified customer profile. This is to be used in conjunction with AuthNetCIMPaymentProfileIndex. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMPaymentProfileId: The Payment Profile ID assigned by Authorize.NET CIM gateway.This config is used to retrieve or set the ID of a Payment Profile. This config will be populated after a Payment Profile is created or when one is retrieved (via a GetSubscriptionStatus call). Additionally when AuthNetCIMRequestType is set to '1' (Payment Profile), the Payment Profile ID must be set, via this config, when performing the following operations: UpdateSubscription, CancelSubscription, or GetSubscriptionStatus. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMPaymentProfileIndex: Parses the Payment Profile contained at the specified index within a GetSusbcriptionStatus response.This is an actionable config that parses the Payment Profile contained within the response at the specified index. This is a 1-based index and is to be used in conjunction with AuthNetCIMPaymentProfileCount. Index values less than 1 and greater than AuthNetCIMPaymentProfileCount will cause an exception to be thrown. When this config is set, the Payment Profile at the specified index will be parsed and the Card, ECheckBank, and Customer properties will be populated based on the data in the response. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMRequestType:
The request type to send for the Authorize.NET CIM gateway.This config is used to specify the request type to send for the Authorize.NET CIM gateway and is
used in conjunction with the API methods to perform various actions.
The available request types are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMShippingAddressCount: The number of Shipping Addresses assigned to a customer profile within the Authorize.NET CIM gateway.This config is populated after a GetSubscriptionStatus call for a Profile (AuthNetCIMRequestType set to '0') and contains the total number of Shipping Addresses assigned to the specified customer profile. This is to be used in conjunction with AuthNetCIMShippingAddressIndex. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMShippingAddressId: The Shipping Address ID assigned by Authorize.NET CIM gateway.This config is used to retrieve or set the ID of a Shipping Address. This config will be populated after a Shipping Address is created or when one is retrieved (via a GetSubscriptionStatus call). Additionally when AuthNetCIMRequestType is set to '2' (Shipping Address), the Shipping Address ID must be set, via this config, when performing the following operations: UpdateSubscription, CancelSubscription, or GetSubscriptionStatus. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetCIMShippingAddressIndex: Parses the Shipping Address contained at the specified index within a GetSusbcriptionStatus response.This is an actionable config that parses the Shipping Address contained within the response at the specified index. This is a 1-based index and is to be used in conjunction with AuthNetCIMShippingAddressCount. Index values less than 1 and greater than AuthNetCIMShippingAddressCount will cause an exception to be thrown. When this config is set, the Shipping Address at the specified index will be parsed and the ShippingInfo properties will be populated based on the data in the response. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetGetSubscriptionDetails: Specifies whether a call to GetSubscriptionStatus will return the details of the subscription or just the status.When getting the status of a subscription in the Authorize.Net gateway, if this configuration setting is set to "False" (default) GetSubScriptionStatus will only return the Status of the subscription in SubscriptionDetails. When set to "True", calling GetSubscriptionStatus will return more details about the subscription and populate other fields in SubscriptionDetails, as well as AuthNetCIMMaskedCardNumber, AuthNetCIMPaymentProfileId, AuthNetShipToCompany, and AuthNetCIMShippingAddressId. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetOpaqueDescriptor:
An Authorize.Net opaque data descriptor.This setting can be set to an Authorize.Net opaque data descriptor in order to use it in place of explicit card or bank account information. AuthNetOpaqueValue must also be set.
This setting is only valid with the gwAuthorizeNetXML and gwAuthorizeNetCIM gateways, it cannot be used with the gwAuthorizeNet gateway. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetOpaqueValue:
An Authorize.Net opaque data value.This setting can be set to an Authorize.Net opaque data value in order to use it in place of explicit card or bank account information. AuthNetOpaqueDescriptor must also be set.
This setting is only valid with the gwAuthorizeNetXML and gwAuthorizeNetCIM gateways, it cannot be used with the gwAuthorizeNet gateway. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AuthNetShipToCompany: The name of the company associated with the customer's shipping address.This configuration setting can be used to set the company associated with the shipping address of the customer. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BamboraUsername: The Username used for authentication with the Bambora gateway.This config is used to specify the 'username' value to authenticate with the Bambora gateway and is only applicable when calling CreateSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSCardInfoKey: BASYS Gateway Credit Card Info Key.This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting BASYSRequestType configuration setting to 1. This configuration setting must be set when BASYSRequestType configuration setting is set to 1 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSCheckInfoKey: BASYS Gateway Check Info Key.This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting BASYSRequestType configuration setting to 2. This configuration setting must be set when BASYSRequestType configuration setting is set to 2 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSContractID: BASYS Gateway Contract ID.Unique identifier assigned to the contract by the merchant at the time the payment schedule is created. This configuration setting must be set when BASYSRequestType configuration setting is set to 3 and when calling CreateSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSContractKey: BASYS Gateway Contract Key.This configuration setting is populated at the time the payment schedule is added to the system by calling CreateSubscription and setting BASYSRequestType configuration setting to 3. This configuration setting must be set when BASYSRequestType configuration setting is set to 3 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSCustomerKey: BASYS Gateway Customer Key.This configuration setting is populated at the time the customer profile is created by calling CreateSubscription and setting BASYSRequestType configuration setting to 0. This configuration setting must be set when the BASYSRequestType configuration setting is set to 1, 2, 3, 4 and 5 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSCustomerStatus:
Indicates the Customer Status.Customer status at the time the customer profile is created and BASYSRequestType is set to 0 (Default).
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSNextBillingDate:
BASYS Gateway Next Billing Date.Identifies the next time the contract will come due in MM/DD/YYYY format. This configuration setting must be set when BASYSRequestType configuration setting is set to 3 and when calling CreateSubscription, and UpdateSubscription.
Note: If only the billing date is to be updated, it is better to set the BASYSRequestType configuration setting to 4 and set the BASYSNumberOfDays configuration setting to the number of days to be added to the billing date. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSNumberOfDays: Number of days to be added to the next billing date.This configuration setting must be set to the number of days to be added to the next billing date when BASYSRequestType configuration setting is set to 4 and when calling and UpdateSubscription. BASYSContractKey must also be set to the corresponding contract key. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSPaymentType:
Indicates the Payment Type.When BASYSRequestType is set to 3 (Recurring Payment) a payment type must be set to one of the following values.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSRequestType:
The request type for the BASYS gateway.This configuration setting is used to specify the request type for the BASYS gateway.
See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSToken: BASYS Gateway Token Value.This configuration setting is populated at the time the Token is created by calling CreateSubscription and setting BASYSRequestType configuration setting to 5. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BASYSTokenMode:
Indicates the Token Type.When BASYSRequestType is set to 5 (Get Token) a token type must be set to one of the following values.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BlueSnapCardCount:
How many card payment sources the last retrieved vaulted shopper has.When BlueSnapRequestType is set to 2, this setting can be queried to determine how many card payment sources the last retrieved
vaulted shopper profile has.
Important: Be sure to call GetSubscriptionStatus after setting BlueSnapRequestType (or after calling UpdateSubscription with it already set) in order to ensure that you have retrieved the most recent data! |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BlueSnapCardIndex:
Determines which card payment source the class's fields are populated for currently.When BlueSnapRequestType is set to 2, this setting can be used to specify which of the last retrieved vaulted shopper's card payment
sources the class should populate its fields with. Valid values are -1 to BlueSnapCardCount-1.
To add a new card payment source, set this to -1, which will cause the class to reset the populated fields to their default values. To update an existing card payment source (be it the card expiration date or its billing information), first set this to the desired card's index, modify the fields you wish to change, and set the full card number and security code, and then call UpdateSubscription. (The update request will fail if you do not set the full card number and security code first, they are not returned when the vaulted shopper is retrieved.) Note that the BlueSnap API makes no guarantee about the order of the card payment sources when it returns a vaulted shopper response. As such, it is important that you never assume that you know which card is at a particular index right after you call GetSubscriptionStatus or UpdateSubscription. Important: Be sure to call GetSubscriptionStatus after setting BlueSnapRequestType (or after calling UpdateSubscription with it already set) in order to ensure that you have retrieved the most recent data! |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BlueSnapEnterpriseUdfs:
User-Defined Fields (UDFs) to send when updating a BlueSnap vaulted shopper.This setting can be set to a JSON object like the following one in order to send Enterprise UDFs when updating a vaulted shopper profile's payment source:
{"udf": [
{
"udfValue": "aaa",
"udfName": "ENT_UDF1"
},
{
"udfValue": "bbb",
"udfName": "ENT_UDF2"
}
]}
Note: Content set using this setting will be used as the value of the transactionFraudInfo.enterpriseUdfs JSON field in
the request body; it is not validated or manipulated first, it is used "as-is".
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BlueSnapGetToken: Retrieves a new hosted payment fields token (pfToken) from BlueSnap.Each time this setting is queried, it will retrieve a new pfToken from BlueSnap. This token can then be passed to BlueSnap's hosted payment fields libraries, and then later passed in the vaulted shopper request using the special field pfToken. Refer to BlueSnap's documentation for more information about hosted payment fields. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BlueSnapRequestType:
The request type for the BlueSnap gateway.This configuration setting is used to specify the request type for the BlueSnap gateway.
When you set the value of this setting, the class resets the properties, special fields, and configuration settings it uses to map to BlueSnap vaulted shopper fields. Only the following retain their values: Gateway, MerchantLogin, MerchantPassword, TestMode, BlueSnapVaultedShopperId, and Response fields (other than CVVResult and AVSResult, which are reset). It is expected that you will call GetSubscriptionStatus to retrieve and populate the class with the latest vaulted shopper details after setting this (unless you plan to create a new vaulted shopper, or keep in mind that any fields not sent in an update request may be cleared by BlueSnap). See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:
The other request types require you to set the Vaulted Shopper ID via the BlueSnapVaultedShopperId configuration setting, after which you may use the GetSubscriptionStatus and UpdateSubscription methods to retrieve and add/update vaulted shopper data (note that any method parameters are ignored). Note that all basic information is automatically retrieved and then re-sent when adding/updating any payment source in order to prevent BlueSnap from clearing those fields. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BlueSnapVaultedShopperId: BlueSnap gateway vaulted shopper ID.This configuration setting must be set to a valid vaulted shopper ID when updating a BlueSnap vaulted shopper. After creating a new vaulted shopper, it will contain the newly created vaulted shopper's ID. See BlueSnapRequestType for more information. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardIssueNumber: Special Issue Number used for Switch and Solo cards.This field is used for the gateways the support International card types. Supported gateways include: Adyen, Barclay, CyberSource, FastTransact, HSBC, NetBanx, NetBilling, Orbital, PayFuse, PaymentExpress, PayPoint, PlugNPay, SagePay, SECPay, and WorldPayXML. Switch, Solo, and some Maestro cards have a 1 or 2 digit Issue number printed on the front of the card, directly following the card number. If that issue number is present, it should be set with this config setting. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardLast4Digits: The last 4 digits of a credit card.This configuration setting is used to specify the last 4 digits of the credit card in certain scenarios. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardPresent:
Specifies whether the card is present during the transaction.When set to "True" (default value), in the case of a manually entered card, the transaction
will be processed with the card being identified as present. When set to "False", the transaction
will be processed as a 'Card Not Present' transaction.
This config is currently applicable to the Heartland gateway. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardStartMonth: Used for some international cards.If there is a Start Date present on the card, set the month here and the year in CardStartYear. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardStartYear: Used for some international cards.If there is a Start Date on present on the card, set the year here and the month in CardStartMonth. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardToken:
The credit card token.This configuration setting is used to specify the credit card token (sometimes called a "nonce") to perform a transaction.
Note that this is only valid when the Gateway property is set to gwNuvei or gwSquare. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CardType:
Type of credit card being used in this transaction.This config is used to specify the type of credit card being used in a retail transaction.
The type will be computed by the component based on the Card data but this value can be
specified to override any computed values.
The available card types are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CheckNumber: Check Number.This configuration setting contains the Check Number. This is valid only for the BASYS, PhoeniXGate, and Repay gateways. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CheckRoutingNumber: Determines whether to perform a checksum test on the RoutingNumber.When set to 'true', the component will perform a checksum test on the BankRoutingNumber when CreateSubscription is called. This check helps identify errors within the specified BankRoutingNumber. Note that this check does not guarantee that the BankRoutingNumber is correct for the bank you wish to work with but does help in identifying mistyped numbers. The default value is 'false'. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| COFPermission: Indicates if the customer gave permission to make a Card On File transaction.When true, this setting indicates that the customer gave the merchant permission to perform a Card On File (COF) transaction. Currently only used by CardPointe (gwCardPointe). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CompanyName: The Customer's Company Name.This config contains the Customer's Company Name associated with the billing address. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ConvenienceFee: The total convenience fee charged for a transaction.This field is used to specify the total convenience fee charged for the transaction. This field is applicable to the FirstDataPayPoint and Litle / Vantiv gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CustomerPassword: The Customer's Password.This field is used to set a password for the customer. This field has different uses depending on the gateway. Please see the gateway specifications for further information as to how this field is used. This config is applicable to the PlugNPay gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CustomerUsername: The Customer's Username.This field is used to set a username for the customer. This field has different uses depending on the gateway. Please see the gateway specifications for further information as to how this field is used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CyberSourceDeleteSubscription:
Whether subscriptions should be deleted when CancelSubscription is called.This setting determines whether CyberSource subscriptions will be deleted (True) or just cancelled (False) when the CancelSubscription method is called.
By default this setting is False; calling CancelSubscription will cause a subscription to be cancelled, but it will remain in the CyberSource Business Center. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CyberSourceXMLEscape: Determines whether to XML escape the CyberSource gateway request field values.If this setting is set to "True", the request field values will be XML escaped prior to being sent to the CyberSource gateway. If this setting is set to "False" (default), the class does not perform any XML escaping and the values are sent exactly as specified. The default value is "False". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| DateFormat:
The format of the date properties.This field is used to specify the date format to be used for the various date properties: PaymentScheduleStartDate,
PaymentScheduleEndDate, SubscriptionDetailsStartDate, SubscriptionDetailsEndDate,
SubscriptionDetailsNextPaymentDate, and SubscriptionDetailsLastPaymentDate. The date must be specified
and will be displayed in the format specified. The default format is: "MM/dd/yyyy".
Applicable format values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EscapeXML: Automatically escape data within XML tags.When set to true, this config will cause the component to automatically escape the XML data in the request. The default value is false. This is currently only supported in the Authorize.Net XML and CIM gateways. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EwayCustomerId: The Customer Id used to authenticate with the Eway gateway.This config is used to specify the Customer Id for the Eway account and is used for authentication. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EwayInitialDate: The date of the initial payment for the Eway gateway.This setting may be used to specify the date that the PaymentScheduleInitialAmount should be charged. The date is based on the format specified via DateFormat and must be the same as, or before PaymentScheduleStartDate. This setting is optional. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
EwayTransactionType:
The Transaction Type for the Eway gateway.This setting defines the transaction type for the Eway gateway and is applicable
when calling CreateSubscription, UpdateSubscription, GetSubscriptionStatus, and CancelSubscription.
See RecurringBilling Gateway Setup and Required Properties for details.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HashAlgorithm:
Algorithm used for hashing.Certain gateways allow the request to be hashed as an additional authentication mechanism. This configuration setting controls which algorithm is used for hashing. Valid values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HashSecret:
Security key used to generate a hash for gateways supporting such functionality.Some gateways allow for the generation of a hash for added security. The following gateways
support this config.
Authorize.Net: The newest version of the protocol includes an optional Hash Secret, which may be used to verify that a server response is actually from an Authorize.Net server. The hash secret is concatenated with the MerchantLogin, ResponseTransactionId, and TransactionAmount. This value is then hashed with the MD5 algorithm and compared to the value returned by the server. If they do not match, the class fails with an error. If the AIMHashSecret is left blank, this check will not be performed. The Server's Hash Secret may be set using the Authorize.Net online merchant interface, located at https://secure.authorize.net/. Bank of America: This value will be the HMAC Key generated for you by the gateway. This value is required and an exception will be thrown if not specified. BarClay and Ingenico: This value is optional and when specified 'SHASIGN' parameter will be computed and sent. Bambora/Beanstream: If hash validation is required then set this to your hash key. HashAlgorithm will also need to be set accordingly. Nuvei: This value is required in all transactions. The value is unique to each terminal and can be set through the online interface at "https://testpayments.nuvei.com/merchant/selfcare/". USAePay: This value is optional and when a 'Pin' value is specified, the 'UMhash' parameter will be computed and sent. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LicenseDOB: Customer's Date of Birth as indicated on his drivers license.This config contains the customer's date of birth as it appears on his driver's license. The format varies between gateways, so please see the specifications for correct formatting. This config may be used by the gateway for fraud screening. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LicenseNumber: Customer's driver's license number.This config contains the customer's driver's license number and may be used by the gateway for fraud screening. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LicenseState: State in which customer's driver's license was issued.This config contains the two-digit abbreviated postal code indicating the state in which the customer's driver's license was issued. This config may be used by the gateway for fraud screening. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LitleCardholderId:
Describes the method used to identify the cardholder at the point of sale for the Litle gateway.This specifies the method used to identify the customer when performing a retail transaction.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantCode:
A gateway-supplied merchant number, code, or Id.For the CardPointe gateway, this configuration setting is required, and should contain your Merchant Id.
For the Litle gateway, this configuration setting is required, and should contain your Merchant Id. For the MIT gateway, this configuration setting is required, and should contain your Merchant Number (Contado). For the Priority Payment Systems gateway, this configuration setting is required, and should contain your Merchant Id. For the WorldPayXML gateway, this configuration setting is optional; it is only needed if you require that the "merchantCode" sent in the request be different from your MerchantLogin (e.g., when processing AMEX transactions, or when supporting multiple currencies). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantPartnersLast4Digits: The last 4 digits of the account number for a transaction processed via the MerchantPartners or WorldPay Link gateways.The last 4 digits of the account number are required to perform UpdateSubscription, CancelSubscription, and GetSubscriptionStatus methods for the MerchantPartners or the WorldPay Link gateways. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MerchantPartnersReaderType:
The reader type used to read and encrypt a swiped card for the MerchantPartners or WorldPay Link gateways.This setting is used to specify the encrypted reader type used to read and encrypt a swiped card. The specified value is sent
in the request and is used by the gateway to decrypt the card data so the transaction can be processed.
Valid Values:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITFlag: For the MIT framework - Used to indicate that a transaction is merchant initiated.When making a Merchant Initiated Transaction (MIT), this configuration setting should be set to true to indicate to the payment gateway that the transaction is merchant initiated. Used by the Orbital payment gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITPriorTransId: For the MIT framework - Used to specify a prior transaction id to be referenced in a merchant initiated transaction.When making a Merchant Initiated Transaction (MIT), this configuration setting can be used to specify the transaction Id of a previously successful authorization. Used by the Orbital and CyberSource payment gateways. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MITType: For the MIT framework - Indicates the type of transaction being requested in a Merchant-Initiated Transaction (MIT).When making a Merchant Initiated Transaction (MIT), this configuration setting is used to specify the type or reason for the merchant initiated transaction. The possible values and formats for this field vary by gateway, so check the gateway's documentation for the associated values and their meanings. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MyVirtualMerchantUserId: The MyVirtualMerchant user Id as configured on VirtualMerchant.This field is used to specify your MyVirtualMerchant user Id which is required (along with MerchantLogin and MerchantPassword) as part of the user authentication. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NetBillingVersion: The Version to be sent in the User-Agent heading of a NetBilling gateway request.The Version portion of the User-Agent HTTP header is required by NetBilling. The default value is "1". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NuveiPermittedTerminals: A list of the terminals permitted to use a Nuvei secure card.This config is used when creating a secure card for Nuvei to list the terminals that will be allowed to use the created card. This should be a comma-separated list of terminal Ids, i.e. "11111,22222,33333". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OmniFundTransactionType:
The Transaction Type for the OmniFund gateway.This settings specifies the transaction type for the OmniFund gateway and is applicable
when calling CreateSubscription, UpdateSubscription, GetSubscriptionStatus, and CancelSubscription.
See RecurringBilling Gateway Setup and Required Properties for details.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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.
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.This config is used to specify the IP address of the payer, which is required by some gateways. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PaymentWorkSuiteClientCode: The 3DSI assigned client code sent in a request to the PaymentWorksuite gateway.This field is used to specify the client code that is assigned by 3DSI. This code uniquely identifies your organization for the purpose of accessing and authenticating to the Payment WorkSuite. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PaymentWorkSuiteLocationCode: The 3DSI assigned location code sent in a request to the PaymentWorksuite gateway.This field is used to specify the location code that uniquely identifies a specific location that is associated with the merchant identified by the specified PaymentWorkSuiteMerchantCode. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PaymentWorkSuiteMerchantCode: The 3DSI assigned merchant code sent in a request to the PaymentWorksuite gateway.This field is used to specify the merchant code that uniquely identifies a specific merchant within the Payment WorkSuite. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PaymentWorkSuiteTransactionType:
The transaction type to send for the Payment WorkSuite gateway.This config is used to specify the transaction type to send for the Payment WorkSuite gateway and is
used in conjunction with the API methods to perform various actions.
The available transaction types are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayTraceIntegratorId: Used to specify the Integrator Id value assigned by the PayTrace gateway.This value is assigned by PayTrace and is used for validation and tracking purposes. The default value is: "90000035NSFT". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PayTraceTransactionType:
The Transaction Type for the PayTrace gateway.This setting is used to specify the transaction type for the PayTrace gateway and is applicable
when calling CreateSubscription, UpdateSubscription, and CancelSubscription.
See RecurringBilling Gateway Setup and Required Properties for details.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserCardToken: PayWiser Gateway Card Token Value.This configuration setting is populated at the time the Token is created by calling CreateSubscription and setting PayWiserRequestType configuration setting to 1. This configuration setting must be set to the generated card token when calling CreateSubscription and setting PayWiserRequestType configuration setting to 2. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserPaymentHour: Payment hour.This configuration setting can be used to specify the hour of the day, when each payment will be executed. This configuration setting must be set when automatically creating the recurring schedule using the PaymentSchedule property. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserPlanPattern:
PayWiser plan pattern for creating a recurring plan.This configuration setting can be used to specify a custom plan pattern for recurring payments. If set, this configuration setting will override all the fields previously set using the PaymentSchedule property.
Structure of PayWiserPlanPattern and PayWiserRetryPattern: For daily recurrence:
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:
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:
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:
Example: Y20160301ZZZZZZZZ0010022203ZZZ000 Explanation: Starting from 1.3.2016, there will be payment on every March 22nd and there will be 10 repetitions. If you wish to make a payment every first day of December with 10 repetitions, pattern would be Y20160301ZZZZZZZZ0010120000AAL000. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserRecurringPlanId: PayWiser Recurring Plan Id.This configuration setting is populated at the time the recurring plan is created by calling CreateSubscription and setting PayWiserRequestType configuration setting to 0 (default). This configuration setting must be set to the generated plan id when calling CancelSubscription and setting PayWiserRequestType configuration setting to 3. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserRequestType:
The request type for the PayWiser gateway.This configuration setting is used to specify the request type for the PayWiser gateway.
See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:
The default value is 0 (Customer Profile). Option 0, 1 and 2 are only valid when CreateSubscription method is called. Option 3 and 4 are only valid when calling CancelSubscription method. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserRetryPattern:
PayWiser retry pattern for retrying failed payments.This configuration setting can be used to specify a custom retry pattern for recurring payments in case of a failed payment. Please follow the instructions described in PayWiserPlanPattern for formatting the retry pattern.
Note if this configuration setting is set, MaxRetryCount filed must be also set using the AddSpecialField method. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PayWiserTokenReferenceId: PayWiser Gateway Token Reference Id.This configuration setting is populated at the time the Token is created by calling CreateSubscription and setting PayWiserRequestType configuration setting to 1. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateCardInfoKey: PhoeniXGate Gateway Credit Card Info Key.This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting PhoeniXGateRequestType configuration setting to 1. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 1 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateCheckInfoKey: PhoeniXGate Gateway Check Info Key.This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting PhoeniXGateRequestType configuration setting to 2. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 2 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateContractID: PhoeniXGate Gateway Contract ID.Unique identifier assigned to the contract by the merchant at the time the payment schedule is created. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 3 and when calling CreateSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateContractKey: PhoeniXGate Gateway Contract Key.This configuration setting is populated at the time the payment schedule is added to the system by calling CreateSubscription and setting PhoeniXGateRequestType configuration setting to 3. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 3 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateCustomerKey: PhoeniXGate Gateway Customer Key.This configuration setting is populated at the time the customer profile is created by calling CreateSubscription and setting PhoeniXGateRequestType configuration setting to 0. This configuration setting must be set when the PhoeniXGateRequestType configuration setting is set to 1, 2, 3, 4 and 5 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateCustomerStatus:
Indicates the Customer Status.Customer status at the time the customer profile is created and PhoeniXGateRequestType is set to 0 (Default).
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateNextBillingDate:
PhoeniXGate Gateway Next Billing Date.Identifies the next time the contract will come due in MM/DD/YYYY format. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 3 and when calling CreateSubscription, and UpdateSubscription.
Note: If only the billing date is to be updated, it is better to set the PhoeniXGateRequestType configuration setting to 4 and set the PhoeniXGateNumberOfDays configuration setting to the number of days to be added to the billing date. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateNumberOfDays: Number of days to be added to the next billing date.This configuration setting must be set to the number of days to be added to the next billing date when PhoeniXGateRequestType configuration setting is set to 4 and when calling and UpdateSubscription. PhoeniXGateContractKey must also be set to the corresponding contract key. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGatePaymentType:
Indicates the Payment Type.When PhoeniXGateRequestType is set to 3 (Recurring Payment) a payment type must be set to one of the following values.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateToken: PhoeniXGate Gateway Token Value.This configuration setting is populated at the time the Token is created by calling CreateSubscription and setting PhoeniXGateRequestType configuration setting to 5. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PhoeniXGateTokenMode:
Indicates the Token Type.When PhoeniXGateRequestType is set to 5 (Get Token) a token type must be set to one of the following values.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PlanetPaymentFrequencyDate: The date of the month that a recurring payment should occur for the Planet Payment gateway.This configuration setting is used to specify the date of the month that a recurring payment should occur when PaymentScheduleFrequency is set to "Monthly", or "Yearly". | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PlanetPaymentFrequencyDay:
The day that a recurring payment should occur for the Planet Payment gateway.This configuration setting is used to specify the day of the week that a recurring payment should occur when
PaymentScheduleFrequency is set to "Weekly", "Monthly", or "Yearly".
This setting is made up of two fields, a value and a type.
The value and type are separated with a colon (:), i.e. [value]:[type].
Possible values are:
Possible types are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PlanetPaymentFrequencyMonth:
The month that a recurring payment should occur for the Planet Payment gateway.This setting is used to specify the month that a recurring payment should occur when
PaymentScheduleFrequency is set to "Yearly".
This is used in conjunction with
PlanetPaymentFrequencyDay. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RawRequest:
Returns the data that was sent to the gateway.This may be queried after a call to any method that sends data to the gateway. This will return the request data that was sent to
the gateway which may be useful for troubleshooting purposes. For instance:
component.Sale()
MyString = component.Config("RawRequest")
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RawResponse:
Returns the data that was received from the gateway.This may be queried after a call to any method that sends data to the gateway. This will return the response that was received to
the gateway which may be useful for troubleshooting purposes. For instance:
component.Sale()
MyString = component.Config("RawResponse")
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayCardInfoKey: Repay Gateway Credit Card Info Key.This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting RepayRequestType configuration setting to 1. This configuration setting must be set when RepayRequestType configuration setting is set to 1 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayCheckInfoKey: Repay Gateway Check Info Key.This configuration setting is populated at the time the payment method is added to the system by calling CreateSubscription and setting RepayRequestType configuration setting to 2. This configuration setting must be set when RepayRequestType configuration setting is set to 2 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayContractID: Repay Gateway Contract ID.Unique identifier assigned to the contract by the merchant at the time the payment schedule is created. This configuration setting must be set when RepayRequestType configuration setting is set to 3 and when calling CreateSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayContractKey: Repay Gateway Contract Key.This configuration setting is populated at the time the payment schedule is added to the system by calling CreateSubscription and setting RepayRequestType configuration setting to 3. This configuration setting must be set when RepayRequestType configuration setting is set to 3 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayCustomerKey: Repay Gateway Customer Key.This configuration setting is populated at the time the customer profile is created by calling CreateSubscription and setting RepayRequestType configuration setting to 0. This configuration setting must be set when the RepayRequestType configuration setting is set to 1, 2, 3, 4 and 5 and when calling UpdateSubscription, and CancelSubscription. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayCustomerStatus:
Indicates the Customer Status.Customer status at the time the customer profile is created and RepayRequestType is set to 0 (Default).
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayNextBillingDate:
Repay Gateway Next Billing Date.Identifies the next time the contract will come due in MM/DD/YYYY format. This configuration setting must be set when RepayRequestType configuration setting is set to 3 and when calling CreateSubscription, and UpdateSubscription.
Note: If only the billing date is to be updated, it is better to set the RepayRequestType configuration setting to 4 and set the RepayNumberOfDays configuration setting to the number of days to be added to the billing date. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayNumberOfDays: Number of days to be added to the next billing date.This configuration setting must be set to the number of days to be added to the next billing date when RepayRequestType configuration setting is set to 4 and when calling and UpdateSubscription. RepayContractKey must also be set to the corresponding contract key. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayPaymentType:
Indicates the Payment Type.When RepayRequestType is set to 3 (Recurring Payment) a payment type must be set to one of the following values.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayToken: Repay Gateway Token Value.This configuration setting is populated at the time the Token is created by calling CreateSubscription and setting RepayRequestType configuration setting to 5. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RepayTokenMode:
Indicates the Token Type.When RepayRequestType is set to 5 (Get Token) a token type must be set to one of the following values.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SkipJackStatusIndex: Gets subscription details at the specified status index.This setting may be set after calling GetSubscriptionStatus and will populate SubscriptionDetails with the details located at the specified status index. Valid values are 1 through the value returned by ResponseText. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SquareCustomerCardCount: The number of cards saved to the Square customer profile.Square allows multiple credit cards to be saved to a customer profile. After retrieving a Square customer profile using GetSubscriptionStatus, this configuration setting can be queried to determine how many credit cards are saved to the profile. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SquareCustomerCardId:
The Id of a card saved to a Square customer profile.This configuration setting holds the Id of a card-on-file associated with a Square customer profile.
This setting is automatically populated after creating a new card-on-file, or when SquareCustomerCardIndex is set after retrieving a Square customer profile. This setting must be set before attempting to delete a card-on-file. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SquareCustomerCardIndex:
Which card's details to populate the class with from the retreived Square customer profile.After retrieving a Square customer profile with GetSubscriptionStatus, this configuration setting can be used to select which card-on-file's details the class should reflect.
Valid values are -1 to (SquareCustomerCardCount - 1). Setting to -1 causes the class to reset/remove any currently populated Square customer card data. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SquareRequestType:
What type of Square customer data to create or delete.This configuration setting controls what type of Square customer data is being created (when CreateSubscription is called) or deleted (when CancelSubscription is called). Possible values are:
When set to 0, the CreateSubscription and CancelSubscription methods will create and delete Square customer profiles. When set to 1, the CreateSubscription and CancelSubscription methods will create and delete credit cards on the Square customer whose Id is specified by CustomerId. Note that, regardless of this setting:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StoreCardOnFile: For the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF).For the Stored Credentials framework, this configuration setting should be set to true to indicate that the merchant will be storing the customer's card information. Permission should be obtained from the customer prior to storing card data. This configuration setting is used by the CyberSource gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TaxId: Company's Tax Id or a Customer's Social Security Number.This property contains a Company's Tax Id or a Customer's Social Security Number. In the absence of driver's license information, this property may be used by the gateway for fraud screening. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TerminalCapability:
The capability of the terminal that is used to submit the transaction.This config is used to specify the capability of the terminal being used in a retail transaction.
The available values for the CyberSource gateway are (If not specified, the component will set the value to either '2' or '3' based on the specified CardEntryDataSource.):
The available values for the Litle gateway are (If not specified, the component will set the value to 'magstripe'.):
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TerminalId: Terminal Id value sent in the transaction.Many gateways allow/require an Id (terminal, developer, client, user, etc) sent in addition to the MerchantLogin and MerchantPassword. This config is required by Nuvei and Planet Payment. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TerminalType:
The terminal type that is used to submit the transaction.This config is used to specify the terminal (device) type being used in a retail transaction.
The available values for Chase, First Data, LinkPoint, and YourPay are (required):
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseCardOnFile: For the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request.For the Stored Credentials framework, this configuration setting should be set to true to indicate that the merchant is using stored card information. This configuration setting is used by the CyberSource gateway. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XChildrenCount:
The number of child elements of the current element.The number of child attributes of the current element. The XChildren configuration options will be indexed from 0 to XChildrenCount-1.
The current element is specified via the XPath configuration option. This configuration option is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XChildrenName[x]:
The name of the child element.Provides the name of the x'th child element of the current element.
The current element is specified via the XPath configuration option. This configuration option is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XChildrenXText[x]:
The inner text of the child element.Provides the inner text of the x'th child element of the current element.
The current element is specified via the XPath configuration option. This configuration option is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XElement:
The name of the current element.The current element is specified via the XPath configuration option.
This configuration option is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
XPath:
Provides a way to point to a specific element in the returned XML or JSON response.XPath implements a subset of the XML and JSON XPath specification, allowing you to point to specific elements in the XML or JSON documents.
The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.
The following are possible values for an element accessor:
Example (Setting XPath for XML)
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| XText:
The text of the current element.The current element is specified in the XPath configuration option.
This configuration option is read-only. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTP Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AcceptEncoding: Used to tell the server which types of content encodings the client supports.When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AllowHTTPCompression:
This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data.
When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.
When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate". The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AllowHTTPFallback:
Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server
does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".
If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2. The default value is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Append: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Authorization:
The Authorization string to be sent to the server.If the Authorization property contains a nonempty string,
an Authorization HTTP request header is added to the
request. This header conveys Authorization information to the
server.
This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class. The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BytesTransferred: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ChunkSize: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CompressHTTPRequest:
Set to true to compress the body of a PUT or POST request.If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.
The default value is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| EncodeURL: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FollowRedirects:
Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds
with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.
If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error. Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead. Following are the valid options:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| GetOn302Redirect: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
HTTPVersion:
The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows:
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 NotesWhen using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 NotesHTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| IfModifiedSince:
A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request.
The value of this header is used to make the HTTP request conditional: if the requested documented has not
been modified since the time specified in the field, a copy of the document will not be returned from
the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to Connection: Keep-Alive.
If False, the connection will be closed immediately after the server response is received.
The default value for KeepAlive is False. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LogLevel:
The level of detail that is logged.This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaxRedirectAttempts: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| NegotiatedHTTPVersion: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OtherHeaders:
Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the class beyond what is provided. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyAuthorization: The authorization string to be sent to the proxy server.This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyAuthScheme: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyPassword: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyPort: Port for the proxy server (default 80).This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyServer: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyUser: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classs that do not directly expose Proxy properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SentHeaders: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| StatusLine: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description]. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TransferredData: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TransferredHeaders: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TransferredRequest:
The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:
.NET
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseChunkedEncoding:
Enables or Disables HTTP chunked encoding for transfers.If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible.
HTTP-chunked encoding allows large files to be sent in chunks instead of all at once.
If set to False, the class will not use HTTP-chunked encoding. The default value is False.
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseIDNs:
Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).
The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UsePlatformHTTPClient:
Whether or not to use the platform HTTP client.When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).
Note: This setting is applicable only to Mac/iOS editions. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseProxyAutoConfigURL:
Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to True.
When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UserAgent:
Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default
setting is "IPWorks HTTP Component - www.nsoftware.com".
Override the default with the name and version of your software. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TCPClient Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ConnectionTimeout: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classs that do not directly expose Firewall properties. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallHost:
Name or IP address of firewall (optional).If a FirewallHost is given, requested connections will be authenticated through the specified firewall
when connecting.
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned. Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallPassword:
Password to be used if authentication is to be used when connecting through the firewall.If FirewallHost is specified, the FirewallUser and FirewallPassword settings
are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallPort:
The TCP port for the FirewallHost;.The FirewallPort is set automatically when FirewallType is set to a valid value.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
FirewallType:
Determines the type of firewall to connect through.The appropriate values are as follows:
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallUser:
A user name if authentication is to be used connecting through a firewall.If the FirewallHost is specified, the FirewallUser and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
Note: This setting is provided for use by classs that do not directly expose Firewall properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| KeepAliveInterval:
The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, TCPKeepAlive will automatically be set to True.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet
will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.
Note: This value is not applicable in macOS. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are 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 (e.g., by a client acknowledgment), 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, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LocalHost:
The name of the local host through which connections are initiated or accepted.
The LocalHost setting contains the name of the local host
as obtained by the gethostname() system call, or if the
user has assigned an IP address, the value of that address.
In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LocalPort:
The port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaxLineLength:
The maximum amount of data to accumulate when no EOL is found.MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL
string.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset. If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaxTransferRate: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProxyExceptionsList:
A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use.
When requests are made to hosts specified in this property, the proxy will not be used. For instance:
www.google.com;www.nsoftware.com |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TCPKeepAlive:
Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically
to maintain the connection. Set KeepAliveTime and KeepAliveInterval to
configure the timing of the keep-alive packets.
Note: This value is not applicable in Java. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TcpNoDelay:
Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseIPv6:
Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0.
Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSL Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LogSSLPackets:
Controls whether SSL packets are logged when using the internal security API.When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received. Enabling this setting has no effect if SSLProvider is set to Platform. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpenSSLCADir:
The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpenSSLCAFile:
Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpenSSLCipherList:
A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OpenSSLPrngSeedData:
The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ReuseSSLSession:
Determines if the SSL session is reused.
If set to true, the class will reuse the context if and only if the following criteria are met:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLCACertFilePaths:
The paths to CA certificate files on Unix/Linux.This setting specifies the paths on disk to CA certificate files on Unix/Linux.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates. The default value is: /etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
SSLCACerts:
A newline separated list of CA certificate to use during SSL client authentication.This setting specifies one or more CA certificates to be included in the request when performing
SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented
when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLCheckCRL:
Whether to check the Certificate Revocation List for the server certificate.This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.
When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLCheckOCSP:
Whether to use OCSP to check the status of the server certificate.This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.
When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLCipherStrength:
The minimum cipher strength used for bulk encryption.
This minimum cipher strength largely dependent on the security modules installed
on the system. If the cipher strength specified is not supported,
an error will be returned when connections are initiated.
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLEnabledCipherSuites:
The cipher suite to be used in an SSL negotiation.The enabled cipher suites to be used in SSL negotiation.
By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
SSLEnabledCipherSuites is used together with SSLCipherStrength. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLEnabledProtocols:
Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
SSLEnabledProtocols - TLS 1.3 Notes By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions. In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to 1 (Platform provider) please be aware of the following notes:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLEnableRenegotiation:
Whether the renegotiation_info SSL extension is supported.This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API.
This setting is true by default, but can be set to false to disable the extension.
This setting is only applicable when SSLProvider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLIncludeCertChain:
Whether the entire certificate chain is included in the SSLServerAuthentication event.This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains
the full certificate chain. By default this value is False and only the leaf certificate will be present
in the Encoded parameter of the SSLServerAuthentication event.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLKeyLogFile:
The location of a file where per-session secrets are written for debugging purposes.This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values. Note: This setting is only applicable when SSLProvider is set to Internal. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedCipher:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedCipherStrength:
Returns the negotiated ciphersuite strength.Returns the strength of the ciphersuite negotiated during the SSL handshake.
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedCipherSuite:
Returns the negotiated ciphersuite.Returns the ciphersuite negotiated during the SSL handshake represented as a single string.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedKeyExchange:
Returns the negotiated key exchange algorithm.Returns the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedKeyExchangeStrength:
Returns the negotiated key exchange algorithm strength.Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLNegotiatedVersion:
Returns the negotiated protocol version.Returns the protocol version negotiated during the SSL handshake.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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:
This functionality is currently not available when the provider is OpenSSL. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSLServerCACerts:
A newline separated list of CA certificate to use during SSL server certificate validation.This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.
The value of this setting is a newline (CrLf) separated list of certificates. For instance: -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TLS12SignatureAlgorithms:
Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error. The format of this value is a comma separated list of hash-signature combinations. For instance:
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TLS12SupportedGroups:
The supported groups for ECC.This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1. When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TLS13KeyShareGroups:
The groups for which to pregenerate key shares.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
The groups specified here will have key share data pregenerated locally before establishing a connection.
This can prevent an additional round trip during the handshake if the group is supported by the server.
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting. Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group. In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so. The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TLS13SignatureAlgorithms:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| TLS13SupportedGroups:
The supported groups for (EC)DHE key exchange.This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange.
This setting should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192 The values are ordered from most preferred to least preferred. The following values are supported:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Socket Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| AbsoluteTimeout:
Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds
will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.
Note: This option is not valid for UDP ports. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InBufferSize:
The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OutBufferSize:
The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Config Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MaskSensitive:
Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| UseInternalSecurityAPI:
Tells the class whether or not to use the system security libraries or an internal implementation.
When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.
Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section. |
Trappable Errors (RecurringBilling Class)
RecurringBilling Errors
| 159 Invalid form variable index (out of range). | |
| 501 Data field invalid length. | |
| 502 Data field invalid format. | |
| 503 Data field out of range. | |
| 504 Luhn digit check failed. | |
| 505 Card date invalid. | |
| 506 Card expired. | |
| 507 Card type unknown. | |
| 510 No gateway specified. | |
| 511 Invalid data entered. | |
| 512 Truncated response. | |
| 513 Invalid response. | |
| 514 A Special Field is required for this transaction type. | |
| 535 Signature verification failed. | |
| 542 Error computing MD5 hash for Authorize.Net |
The class may also return one of the following error codes, which are inherited from other classes.
HTTP Errors
| 118 Firewall Error. Error description contains detailed message. | |
| 143 Busy executing current method. | |
| 151 HTTP protocol error. The error message has the server response. | |
| 152 No server specified in URL | |
| 153 Specified URLScheme is invalid. | |
| 155 Range operation is not supported by server. | |
| 156 Invalid cookie index (out of range). | |
| 301 Interrupted. | |
| 302 Can't open AttachedFile. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
| 100 You cannot change the RemotePort at this time. A connection is in progress. | |
| 101 You cannot change the RemoteHost (Server) at this time. A connection is in progress. | |
| 102 The RemoteHost address is invalid (0.0.0.0). | |
| 104 Already connected. If you want to reconnect, close the current connection first. | |
| 106 You cannot change the LocalPort at this time. A connection is in progress. | |
| 107 You cannot change the LocalHost at this time. A connection is in progress. | |
| 112 You cannot change MaxLineLength at this time. A connection is in progress. | |
| 116 RemotePort cannot be zero. Please specify a valid service port number. | |
| 117 You cannot change the UseConnection option while the class is active. | |
| 135 Operation would block. | |
| 201 Timeout. | |
| 211 Action impossible in control's present state. | |
| 212 Action impossible while not connected. | |
| 213 Action impossible while listening. | |
| 301 Timeout. | |
| 302 Could not open file. | |
| 434 Unable to convert string to selected CodePage. | |
| 1105 Already connecting. If you want to reconnect, close the current connection first. | |
| 1117 You need to connect first. | |
| 1119 You cannot change the LocalHost at this time. A connection is in progress. | |
| 1120 Connection dropped by remote host. |
SSL Errors
| 270 Cannot load specified security library. | |
| 271 Cannot open certificate store. | |
| 272 Cannot find specified certificate. | |
| 273 Cannot acquire security credentials. | |
| 274 Cannot find certificate chain. | |
| 275 Cannot verify certificate chain. | |
| 276 Error during handshake. | |
| 280 Error verifying certificate. | |
| 281 Could not find client certificate. | |
| 282 Could not find server certificate. | |
| 283 Error encrypting data. | |
| 284 Error decrypting data. |
TCP/IP Errors
| 10004 [10004] Interrupted system call. | |
| 10009 [10009] Bad file number. | |
| 10013 [10013] Access denied. | |
| 10014 [10014] Bad address. | |
| 10022 [10022] Invalid argument. | |
| 10024 [10024] Too many open files. | |
| 10035 [10035] Operation would block. | |
| 10036 [10036] Operation now in progress. | |
| 10037 [10037] Operation already in progress. | |
| 10038 [10038] Socket operation on non-socket. | |
| 10039 [10039] Destination address required. | |
| 10040 [10040] Message too long. | |
| 10041 [10041] Protocol wrong type for socket. | |
| 10042 [10042] Bad protocol option. | |
| 10043 [10043] Protocol not supported. | |
| 10044 [10044] Socket type not supported. | |
| 10045 [10045] Operation not supported on socket. | |
| 10046 [10046] Protocol family not supported. | |
| 10047 [10047] Address family not supported by protocol family. | |
| 10048 [10048] Address already in use. | |
| 10049 [10049] Can't assign requested address. | |
| 10050 [10050] Network is down. | |
| 10051 [10051] Network is unreachable. | |
| 10052 [10052] Net dropped connection or reset. | |
| 10053 [10053] Software caused connection abort. | |
| 10054 [10054] Connection reset by peer. | |
| 10055 [10055] No buffer space available. | |
| 10056 [10056] Socket is already connected. | |
| 10057 [10057] Socket is not connected. | |
| 10058 [10058] Can't send after socket shutdown. | |
| 10059 [10059] Too many references, can't splice. | |
| 10060 [10060] Connection timed out. | |
| 10061 [10061] Connection refused. | |
| 10062 [10062] Too many levels of symbolic links. | |
| 10063 [10063] File name too long. | |
| 10064 [10064] Host is down. | |
| 10065 [10065] No route to host. | |
| 10066 [10066] Directory not empty | |
| 10067 [10067] Too many processes. | |
| 10068 [10068] Too many users. | |
| 10069 [10069] Disc Quota Exceeded. | |
| 10070 [10070] Stale NFS file handle. | |
| 10071 [10071] Too many levels of remote in path. | |
| 10091 [10091] Network subsystem is unavailable. | |
| 10092 [10092] WINSOCK DLL Version out of range. | |
| 10093 [10093] Winsock not loaded yet. | |
| 11001 [11001] Host not found. | |
| 11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
| 11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
| 11004 [11004] Valid name, no data record (check DNS setup). |