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.

Syntax

class inpay.RecurringBilling

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 gateway_url at this time.

Next, set the merchant_login (and for some gateways the merchant_password). 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 customer_address, customer_first_name, customer_last_name, invoice_number, 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 create_subscription method. If the gateway supports it, you may also Cancel recurring payments with the cancel_subscription method. Recurring payments that need to be changed may be updated with the update_subscription 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.


card_type	Type of credit card being used in this transaction.
card_cvv_data	Three digit security code on back of card (optional).
card_cvv_presence	Indicates the presence of the card verification value.
card_entry_data_source	This property contains a 1-character code identifying the source of the customer data.
card_exp_month	Expiration month of the credit card specified in Number .
card_exp_year	Expiration year of the credit card specified in Number .
card_is_encrypted	Determines whether data set to the Number or MagneticStripe properties is validated.
card_magnetic_stripe	Track data read off of the card's magnetic stripe.
card_number	Customer's credit card number for the transaction.
customer_address	Customer's street address.
customer_address2	A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.
customer_aggregate	This property allows you to get or set an XML aggregate built from all of the Customer properties.
customer_city	Customer's city.
customer_country	Customer's country.
customer_email	Customer's email address.
customer_fax	Customer's fax number.
customer_first_name	Customer's first name.
customer_full_name	Customer's full name.
customer_id	Merchant-generated customer Id.
customer_last_name	Customer's last name.
customer_phone	Customer's phone number.
customer_state	Customer's state.
customer_zip	Customer's zip code (or postal code if outside of the USA).
bank_account_class	Indicates whether a personal or business account is used for this transaction.
bank_account_holder_name	Account holder's name.
bank_account_number	Bank account number for ACH transactions.
bank_account_type	Indicates whether a checking or savings account is used for this transaction.
bank_name	Name of the account holder's bank.
bank_routing_number	Routing number for ACH transactions.
e_check_payment_type	The type of check payment request (commonly referred to as SEC Code).
gateway	Gateway to process transactions with.
gateway_url	Default URL for a specific Gateway .
invoice_number	Merchant-generated invoice number.
merchant_login	Merchant's Gateway login.
merchant_password	Merchant's Gateway password.
payment_schedule_end_date	The end date of the subscription.
payment_schedule_frequency	The frequency of payments.
payment_schedule_frequency_unit	The unit of time to be used when calculating the frequency of payments.
payment_schedule_initial_amount	The initial amount to be charged (such as a trial period or setup fee).
payment_schedule_recur_amount	The amount to be charged on a recurring basis.
payment_schedule_start_date	The date on which the recurring payments will start processing.
payment_schedule_total_payments	The total number of payments.
payment_schedule_trial_payments	The total number of trial payments.
proxy_auth_scheme	This property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detect	This property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_password	This property contains a password if authentication is to be used for the proxy.
proxy_port	This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
proxy_server	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_ssl	This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
proxy_user	This property contains a user name, if authentication is to be used for the proxy.
response_approval_code	Contains an authorization code when a transaction has been approved.
response_approved	Indicates the status of the last transaction.
response_avs_result	Contains the Address Verification System result code.
response_code	Indicates the status of the authorization request.
response_cvv_result	Contains the returned CVV2 result code if it was requested.
response_data	The entire response returned from the gateway processor.
response_error_code	Additional error code returned by some gateways.
response_error_text	Additional error description returned by some gateways.
response_invoice_number	Invoice number submitted in authorization request (if applicable).
response_processor_code	Response code from the underlying processor.
response_subscription_id	Contains the Subscription or Profile Identifier for the recurring payment.
response_text	Text information that describes each response code.
response_transaction_id	Contains the Visa Transaction Identifier or MasterCard Reference Number.
shipping_address	Customer's shipping street address.
shipping_address2	A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.
shipping_city	Customer's shipping city.
shipping_country	Customer's shipping country.
shipping_email	Customer's email address.
shipping_first_name	Customer's first name.
shipping_last_name	Customer's last name.
shipping_phone	Customer's phone number.
shipping_state	Customer's shipping state.
shipping_zip	Customer's shipping zip code (or postal code if outside of the USA).
special_field_count	The number of records in the SpecialField arrays.
special_field_name	Name of special configuration property to submit in this transaction.
special_field_value	Value of special configuration property to submit in this transaction.
ssl_accept_server_cert_encoded	This is the certificate (PEM/base64 encoded).
ssl_cert_encoded	This is the certificate (PEM/base64 encoded).
ssl_cert_store	This is the name of the certificate store for the client certificate.
ssl_cert_store_password	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type	This is the type of certificate store for this certificate.
ssl_cert_subject	This is the subject of the certificate used for client authentication.
ssl_provider	This specifies the SSL/TLS implementation to use.
ssl_server_cert_encoded	This is the certificate (PEM/base64 encoded).
subscription_desc	Description of recurring subscription.
subscription_details_card_exp_month	The expiration month of the card currently being processed for the recurring payments.
subscription_details_card_exp_year	The expiration year of the card currently being processed for the recurring payments.
subscription_details_card_number	The card number currently being processed for the recurring payments.
subscription_details_end_date	The date in which the recurring payments will stop processing.
subscription_details_frequency	The frequency in which payments will occur.
subscription_details_frequency_unit	The unit frequency in which the payments will be processed.
subscription_details_last_payment_date	The date that the last/previous transaction was processed.
subscription_details_next_payment_date	The date of the next upcoming transaction.
subscription_details_recur_amount	The amount being charged on a recurring basis.
subscription_details_remaining_payments	The total number of remaining payments until the recurring payments will stop processing.
subscription_details_start_date	The date in which the recurring payments started processing.
subscription_details_status	The current status of the recurring subscription.
subscription_details_subscription_id	Contains the Subscription or Profile Identifier for the recurring payment.
subscription_details_subscription_name	Contains the name of the recurring subscription or profile.
subscription_details_total_payments	The total number of payments.
subscription_name	The name of the recurring subscription or profile.
test_mode	Turns test mode on and off for transactions sent to the current Gateway .
timeout	A timeout for the class.
transaction_id	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.


add_special_field	Adds a special field name and the corresponding value.
cancel_subscription	Cancels or deletes a recurring payment subscription.
config	Sets or retrieves a configuration setting.
create_subscription	Creates a new recurring subscription.
do_events	Processes events from the internal message queue.
get_response_var	Parses additional information out of the response.
get_subscription_status	Retrieves the status of a recurring payment subscription.
interrupt	Interrupts the current action.
reset_special_fields	Resets all special fields to the default settings.
update_subscription	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.


on_error	Information about errors during data delivery.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	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.

card_type Property

Type of credit card being used in this transaction.

Syntax

def get_card_type() -> int: ...
def set_card_type(value: int) -> None: ...

card_type = property(get_card_type, set_card_type)

Default Value

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

card_cvv_data Property

Three digit security code on back of card (optional).

Syntax

def get_card_cvv_data() -> str: ...
def set_card_cvv_data(value: str) -> None: ...

card_cvv_data = property(get_card_cvv_data, set_card_cvv_data)

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 card_cvv_data 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, card_cvv_presence will be automatically set to cvpProvided. If set to empty string (""), card_cvv_presence will be automatically set to cvpNotProvided.

card_cvv_presence Property

Indicates the presence of the card verification value.

Syntax

def get_card_cvv_presence() -> int: ...
def set_card_cvv_presence(value: int) -> None: ...

card_cvv_presence = property(get_card_cvv_presence, set_card_cvv_presence)

Default Value

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of card_cvv_data.

The class will automatically set this value to cvpProvided when a card_cvv_data value is specified. You can explicitly specify the card_cvv_presence indicator by setting this property.

Available values are:

cvpNotProvided (0)
cvpProvided (1)
cvpIllegible (2)
cvpNotOnCard (3)

card_entry_data_source Property

This property contains a 1-character code identifying the source of the customer data.

Syntax

def get_card_entry_data_source() -> int: ...
def set_card_entry_data_source(value: int) -> None: ...

card_entry_data_source = property(get_card_entry_data_source, set_card_entry_data_source)

Default Value

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

card_exp_month Property

Expiration month of the credit card specified in Number .

Syntax

def get_card_exp_month() -> int: ...
def set_card_exp_month(value: int) -> None: ...

card_exp_month = property(get_card_exp_month, set_card_exp_month)

Default Value

Remarks

Expiration month of the credit card specified in card_number.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

card_exp_year Property

Expiration year of the credit card specified in Number .

Syntax

def get_card_exp_year() -> int: ...
def set_card_exp_year(value: int) -> None: ...

card_exp_year = property(get_card_exp_year, set_card_exp_year)

Default Value

2000

Remarks

Expiration year of the credit card specified in card_number.

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.

card_is_encrypted Property

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

def get_card_is_encrypted() -> bool: ...
def set_card_is_encrypted(value: bool) -> None: ...

card_is_encrypted = property(get_card_is_encrypted, set_card_is_encrypted)

Default Value

FALSE

Remarks

Determines whether data set to the card_number or card_magnetic_stripe fields is validated.

By default, when the card_number or card_magnetic_stripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and card_magnetic_stripe data will be parsed for the track specified by card_entry_data_source. 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 card_number or card_magnetic_stripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the card_type may be affected, and the card number will not be verified.

card_magnetic_stripe Property

Track data read off of the card's magnetic stripe.

Syntax

def get_card_magnetic_stripe() -> str: ...
def set_card_magnetic_stripe(value: str) -> None: ...

card_magnetic_stripe = property(get_card_magnetic_stripe, set_card_magnetic_stripe)

Default Value

Remarks

Track data read off of the card's magnetic stripe.

If card_entry_data_source 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 card_entry_data_source property to indicate which track you are sending.

The following example shows how to set the card_magnetic_stripe and card_entry_data_source 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.

card_number Property

Customer's credit card number for the transaction.

Syntax

def get_card_number() -> str: ...
def set_card_number(value: str) -> None: ...

card_number = property(get_card_number, set_card_number)

Default Value

Remarks

Customer's credit card number for the transaction.

If you're sending the transaction with card_magnetic_stripe data, this property should be left empty.

customer_address Property

Customer's street address.

Syntax

def get_customer_address() -> str: ...
def set_customer_address(value: str) -> None: ...

customer_address = property(get_customer_address, set_customer_address)

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 customer_city, customer_state, and customer_zip 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 add_special_field method. For example:

class.CustomerAddress = "123" class.AddSpecialField("avs_street_name", "Nowhere Ln")

customer_address2 Property

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.

Syntax

def get_customer_address2() -> str: ...
def set_customer_address2(value: str) -> None: ...

customer_address2 = property(get_customer_address2, set_customer_address2)

Default Value

Remarks

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).

customer_aggregate Property

This property allows you to get or set an XML aggregate built from all of the Customer properties.

Syntax

def get_customer_aggregate() -> str: ...
def set_customer_aggregate(value: str) -> None: ...

customer_aggregate = property(get_customer_aggregate, set_customer_aggregate)

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>

customer_city Property

Customer's city.

Syntax

def get_customer_city() -> str: ...
def set_customer_city(value: str) -> None: ...

customer_city = property(get_customer_city, set_customer_city)

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 customer_address, customer_state, and customer_zip.

customer_country Property

Customer's country.

Syntax

def get_customer_country() -> str: ...
def set_customer_country(value: str) -> None: ...

customer_country = property(get_customer_country, set_customer_country)

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

customer_email Property

Customer's email address.

Syntax

def get_customer_email() -> str: ...
def set_customer_email(value: str) -> None: ...

customer_email = property(get_customer_email, set_customer_email)

Default Value

Remarks

Customer's email address. This optional property contains the customer's email address.

customer_fax Property

Customer's fax number.

Syntax

def get_customer_fax() -> str: ...
def set_customer_fax(value: str) -> None: ...

customer_fax = property(get_customer_fax, set_customer_fax)

Default Value

Remarks

Customer's fax number. This optional property contains the customer's fax number.

customer_first_name Property

Customer's first name.

Syntax

def get_customer_first_name() -> str: ...
def set_customer_first_name(value: str) -> None: ...

customer_first_name = property(get_customer_first_name, set_customer_first_name)

Default Value

Remarks

Customer's first name. This property contains the customer's first name.

customer_full_name Property

Customer's full name.

Syntax

def get_customer_full_name() -> str: ...
def set_customer_full_name(value: str) -> None: ...

customer_full_name = property(get_customer_full_name, set_customer_full_name)

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 customer_first_name and customer_last_name properties. If a gateway requires a customer_full_name and the property is empty, customer_full_name will be constructed using the contents of customer_first_name and customer_last_name.

customer_id Property

Merchant-generated customer Id.

Syntax

def get_customer_id() -> str: ...
def set_customer_id(value: str) -> None: ...

customer_id = property(get_customer_id, set_customer_id)

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.

customer_last_name Property

Customer's last name.

Syntax

def get_customer_last_name() -> str: ...
def set_customer_last_name(value: str) -> None: ...

customer_last_name = property(get_customer_last_name, set_customer_last_name)

Default Value

Remarks

Customer's last name. This property contains the customer's last name as it appears on their credit card.

customer_phone Property

Customer's phone number.

Syntax

def get_customer_phone() -> str: ...
def set_customer_phone(value: str) -> None: ...

customer_phone = property(get_customer_phone, set_customer_phone)

Default Value

Remarks

Customer's phone number. This optional property contains the customer's phone number.

customer_state Property

Customer's state.

Syntax

def get_customer_state() -> str: ...
def set_customer_state(value: str) -> None: ...

customer_state = property(get_customer_state, set_customer_state)

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 customer_address, customer_city, and customer_zip.

customer_zip Property

Customer's zip code (or postal code if outside of the USA).

Syntax

def get_customer_zip() -> str: ...
def set_customer_zip(value: str) -> None: ...

customer_zip = property(get_customer_zip, set_customer_zip)

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 customer_address, customer_city, and customer_state.

bank_account_class Property

Indicates whether a personal or business account is used for this transaction.

Syntax

def get_bank_account_class() -> int: ...
def set_bank_account_class(value: int) -> None: ...

bank_account_class = property(get_bank_account_class, set_bank_account_class)

Default Value

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.

bank_account_holder_name Property

Account holder's name.

Syntax

def get_bank_account_holder_name() -> str: ...
def set_bank_account_holder_name(value: str) -> None: ...

bank_account_holder_name = property(get_bank_account_holder_name, set_bank_account_holder_name)

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.

bank_account_number Property

Bank account number for ACH transactions.

Syntax

def get_bank_account_number() -> str: ...
def set_bank_account_number(value: str) -> None: ...

bank_account_number = property(get_bank_account_number, set_bank_account_number)

Default Value

Remarks

Bank account number for ACH transactions. This property contains the customer's bank account number, which along with the bank_routing_number identify the location of the account where funds are to be drawn from for ACH transactions. This property is required for all ACH transactions.

bank_account_type Property

Indicates whether a checking or savings account is used for this transaction.

Syntax

def get_bank_account_type() -> int: ...
def set_bank_account_type(value: int) -> None: ...

bank_account_type = property(get_bank_account_type, set_bank_account_type)

Default Value

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.

bank_name Property

Name of the account holder's bank.

Syntax

def get_bank_name() -> str: ...
def set_bank_name(value: str) -> None: ...

bank_name = property(get_bank_name, set_bank_name)

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

bank_routing_number Property

Routing number for ACH transactions.

Syntax

def get_bank_routing_number() -> str: ...
def set_bank_routing_number(value: str) -> None: ...

bank_routing_number = property(get_bank_routing_number, set_bank_routing_number)

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

e_check_payment_type Property

The type of check payment request (commonly referred to as SEC Code).

Syntax

def get_e_check_payment_type() -> int: ...
def set_e_check_payment_type(value: int) -> None: ...

e_check_payment_type = property(get_e_check_payment_type, set_e_check_payment_type)

Default Value

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.

gateway Property

Gateway to process transactions with.

Syntax

def get_gateway() -> int: ...
def set_gateway(value: int) -> None: ...

gateway = property(get_gateway, set_gateway)

Default Value

Remarks

This property is used to select the gateway with which transactions will be processed. Setting the gateway property will also fill the gateway_url, special_field_name, and special_field_value 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/

gateway_url Property

Default URL for a specific Gateway .

Syntax

def get_gateway_url() -> str: ...
def set_gateway_url(value: str) -> None: ...

gateway_url = property(get_gateway_url, set_gateway_url)

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.

invoice_number Property

Merchant-generated invoice number.

Syntax

def get_invoice_number() -> str: ...
def set_invoice_number(value: str) -> None: ...

invoice_number = property(get_invoice_number, set_invoice_number)

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.

merchant_login Property

Merchant's Gateway login.

Syntax

def get_merchant_login() -> str: ...
def set_merchant_login(value: str) -> None: ...

merchant_login = property(get_merchant_login, set_merchant_login)

Default Value

Remarks

This is the login Id supplied by the gateway you signed up with to process credit card transactions.

merchant_password Property

Merchant's Gateway password.

Syntax

def get_merchant_password() -> str: ...
def set_merchant_password(value: str) -> None: ...

merchant_password = property(get_merchant_password, set_merchant_password)

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.

payment_schedule_end_date Property

The end date of the subscription.

Syntax

def get_payment_schedule_end_date() -> str: ...
def set_payment_schedule_end_date(value: str) -> None: ...

payment_schedule_end_date = property(get_payment_schedule_end_date, set_payment_schedule_end_date)

Default Value

Remarks

The end date of the subscription.

The default format is "MM/dd/yyyy" and is controlled by DateFormat, or get_subscription_status.

payment_schedule_frequency Property

The frequency of payments.

Syntax

def get_payment_schedule_frequency() -> str: ...
def set_payment_schedule_frequency(value: str) -> None: ...

payment_schedule_frequency = property(get_payment_schedule_frequency, set_payment_schedule_frequency)

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 payment_schedule_frequency_unit is applicable to the gateway, this property specifies the length of time between charges. This is used in combination with payment_schedule_frequency_unit to specify the frequency of the billing. For instance if payment_schedule_frequency_unit is set to "Days" and payment_schedule_frequency is set to "5", payments will occur every 5 days.

payment_schedule_frequency_unit Property

The unit of time to be used when calculating the frequency of payments.

Syntax

def get_payment_schedule_frequency_unit() -> str: ...
def set_payment_schedule_frequency_unit(value: str) -> None: ...

payment_schedule_frequency_unit = property(get_payment_schedule_frequency_unit, set_payment_schedule_frequency_unit)

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"

payment_schedule_initial_amount Property

The initial amount to be charged (such as a trial period or setup fee).

Syntax

def get_payment_schedule_initial_amount() -> str: ...
def set_payment_schedule_initial_amount(value: str) -> None: ...

payment_schedule_initial_amount = property(get_payment_schedule_initial_amount, set_payment_schedule_initial_amount)

Default Value

Remarks

The initial amount to be charged (such as a trial period or setup fee). This amount can vary from payment_schedule_recur_amount.

payment_schedule_recur_amount Property

The amount to be charged on a recurring basis.

Syntax

def get_payment_schedule_recur_amount() -> str: ...
def set_payment_schedule_recur_amount(value: str) -> None: ...

payment_schedule_recur_amount = property(get_payment_schedule_recur_amount, set_payment_schedule_recur_amount)

Default Value

Remarks

The amount to be charged on a recurring basis. This amount can vary from payment_schedule_initial_amount.

payment_schedule_start_date Property

The date on which the recurring payments will start processing.

Syntax

def get_payment_schedule_start_date() -> str: ...
def set_payment_schedule_start_date(value: str) -> None: ...

payment_schedule_start_date = property(get_payment_schedule_start_date, set_payment_schedule_start_date)

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

payment_schedule_total_payments Property

The total number of payments.

Syntax

def get_payment_schedule_total_payments() -> int: ...
def set_payment_schedule_total_payments(value: int) -> None: ...

payment_schedule_total_payments = property(get_payment_schedule_total_payments, set_payment_schedule_total_payments)

Default Value

Remarks

The total number of payments. Valid values differ between gateways. See RecurringBilling Gateway Setup and Required Properties for details.

payment_schedule_trial_payments Property

The total number of trial payments.

Syntax

def get_payment_schedule_trial_payments() -> int: ...
def set_payment_schedule_trial_payments(value: int) -> None: ...

payment_schedule_trial_payments = property(get_payment_schedule_trial_payments, set_payment_schedule_trial_payments)

Default Value

Remarks

The total number of trial payments.

proxy_auth_scheme Property

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

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 proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme 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 proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

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.

proxy_password Property

This property contains a password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

Remarks

This property contains a password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

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.

proxy_user Property

This property contains a user name, if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

response_approval_code Property

Contains an authorization code when a transaction has been approved.

Syntax

def get_response_approval_code() -> str: ...

response_approval_code = property(get_response_approval_code, None)

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 response_code returned indicates that the transaction is not approved, then the contents of this property should be ignored.

This property is read-only.

response_approved Property

Indicates the status of the last transaction.

Syntax

def get_response_approved() -> bool: ...

response_approved = property(get_response_approved, None)

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

response_avs_result Property

Contains the Address Verification System result code.

Syntax

def get_response_avs_result() -> str: ...

response_avs_result = property(get_response_avs_result, None)

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


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

response_code Property

Indicates the status of the authorization request.

Syntax

def get_response_code() -> str: ...

response_code = property(get_response_code, None)

Default Value

Remarks

Indicates the status of the authorization request. This property contains the actual response code as returned by the Gateway. Unlike the response_approved property, this response_code property may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the response_code as well as the response_approved property. The Point of Sale system should evaluate this response code and NOT the response_text 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.

response_cvv_result Property

Contains the returned CVV2 result code if it was requested.

Syntax

def get_response_cvv_result() -> str: ...

response_cvv_result = property(get_response_cvv_result, None)

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.

A gateway may also support custom codes or human-readable response messages in this property. Please consult your gateway documentation to determine if CVV2 codes are supported.

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

(Note: There are some scenarios in which the property will be empty instead, refer to BlueSnap's documentation for more details.)

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.

response_data Property

The entire response returned from the gateway processor.

Syntax

def get_response_data() -> str: ...

response_data = property(get_response_data, None)

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.

response_error_code Property

Additional error code returned by some gateways.

Syntax

def get_response_error_code() -> str: ...

response_error_code = property(get_response_error_code, None)

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 response_error_text for a human-readable description of this response_error_code.

This property is read-only.

response_error_text Property

Additional error description returned by some gateways.

Syntax

def get_response_error_text() -> str: ...

response_error_text = property(get_response_error_text, None)

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 response_error_code for an accompanying code which may be parsed and used by your application.

This property is read-only.

response_invoice_number Property

Invoice number submitted in authorization request (if applicable).

Syntax

def get_response_invoice_number() -> str: ...

response_invoice_number = property(get_response_invoice_number, None)

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.

response_processor_code Property

Response code from the underlying processor.

Syntax

def get_response_processor_code() -> str: ...

response_processor_code = property(get_response_processor_code, None)

Default Value

Remarks

Response code from the underlying processor. Often times a Gateway will return a response_code 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.

response_subscription_id Property

Contains the Subscription or Profile Identifier for the recurring payment.

Syntax

def get_response_subscription_id() -> str: ...

response_subscription_id = property(get_response_subscription_id, None)

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.

response_text Property

Text information that describes each response code.

Syntax

def get_response_text() -> str: ...

response_text = property(get_response_text, None)

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.

response_transaction_id Property

Contains the Visa Transaction Identifier or MasterCard Reference Number.

Syntax

def get_response_transaction_id() -> str: ...

response_transaction_id = property(get_response_transaction_id, None)

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.

shipping_address Property

Customer's shipping street address.

Syntax

def get_shipping_address() -> str: ...
def set_shipping_address(value: str) -> None: ...

shipping_address = property(get_shipping_address, set_shipping_address)

Default Value

Remarks

Customer's shipping street address.

shipping_address2 Property

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.

Syntax

def get_shipping_address2() -> str: ...
def set_shipping_address2(value: str) -> None: ...

shipping_address2 = property(get_shipping_address2, set_shipping_address2)

Default Value

Remarks

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).

shipping_city Property

Customer's shipping city.

Syntax

def get_shipping_city() -> str: ...
def set_shipping_city(value: str) -> None: ...

shipping_city = property(get_shipping_city, set_shipping_city)

Default Value

Remarks

Customer's shipping city.

shipping_country Property

Customer's shipping country.

Syntax

def get_shipping_country() -> str: ...
def set_shipping_country(value: str) -> None: ...

shipping_country = property(get_shipping_country, set_shipping_country)

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.

shipping_email Property

Customer's email address.

Syntax

def get_shipping_email() -> str: ...
def set_shipping_email(value: str) -> None: ...

shipping_email = property(get_shipping_email, set_shipping_email)

Default Value

Remarks

Customer's email address.

shipping_first_name Property

Customer's first name.

Syntax

def get_shipping_first_name() -> str: ...
def set_shipping_first_name(value: str) -> None: ...

shipping_first_name = property(get_shipping_first_name, set_shipping_first_name)

Default Value

Remarks

Customer's first name.

shipping_last_name Property

Customer's last name.

Syntax

def get_shipping_last_name() -> str: ...
def set_shipping_last_name(value: str) -> None: ...

shipping_last_name = property(get_shipping_last_name, set_shipping_last_name)

Default Value

Remarks

Customer's last name.

shipping_phone Property

Customer's phone number.

Syntax

def get_shipping_phone() -> str: ...
def set_shipping_phone(value: str) -> None: ...

shipping_phone = property(get_shipping_phone, set_shipping_phone)

Default Value

Remarks

Customer's phone number.

shipping_state Property

Customer's shipping state.

Syntax

def get_shipping_state() -> str: ...
def set_shipping_state(value: str) -> None: ...

shipping_state = property(get_shipping_state, set_shipping_state)

Default Value

Remarks

Customer's shipping state.

shipping_zip Property

Customer's shipping zip code (or postal code if outside of the USA).

Syntax

def get_shipping_zip() -> str: ...
def set_shipping_zip(value: str) -> None: ...

shipping_zip = property(get_shipping_zip, set_shipping_zip)

Default Value

Remarks

Customer's shipping zip code (or postal code if outside of the USA).

special_field_count Property

The number of records in the SpecialField arrays.

Syntax

def get_special_field_count() -> int: ...
def set_special_field_count(value: int) -> None: ...

special_field_count = property(get_special_field_count, set_special_field_count)

Default Value

Remarks

This property controls the size of the following arrays:

special_field_name
special_field_value

The array indices start at 0 and end at special_field_count - 1.

special_field_name Property

Name of special configuration property to submit in this transaction.

Syntax

def get_special_field_name(field_index: int) -> str: ...
def set_special_field_name(field_index: int, value: str) -> None: ...

Default Value

Remarks

Name of special configuration field to submit in this transaction. The special_field_name and special_field_value 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 field_index parameter specifies the index of the item in the array. The size of the array is controlled by the special_field_count property.

special_field_value Property

Value of special configuration property to submit in this transaction.

Syntax

def get_special_field_value(field_index: int) -> str: ...
def set_special_field_value(field_index: int, value: str) -> None: ...

Default Value

Remarks

Value of special configuration field to submit in this transaction. The special_field_name and special_field_value 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 field_index parameter specifies the index of the item in the array. The size of the array is controlled by the special_field_count property.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject 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).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

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 list_store_certificates method may be called after setting cert_store_type to `cstPKCS11`, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
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.

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

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.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

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.

Additional Notes

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.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

subscription_desc Property

Description of recurring subscription.

Syntax

def get_subscription_desc() -> str: ...
def set_subscription_desc(value: str) -> None: ...

subscription_desc = property(get_subscription_desc, set_subscription_desc)

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.

subscription_details_card_exp_month Property

The expiration month of the card currently being processed for the recurring payments.

Syntax

def get_subscription_details_card_exp_month() -> int: ...

subscription_details_card_exp_month = property(get_subscription_details_card_exp_month, None)

Default Value

Remarks

The expiration month of the card currently being processed for the recurring payments.

This property is read-only.

subscription_details_card_exp_year Property

The expiration year of the card currently being processed for the recurring payments.

Syntax

def get_subscription_details_card_exp_year() -> int: ...

subscription_details_card_exp_year = property(get_subscription_details_card_exp_year, None)

Default Value

Remarks

The expiration year of the card currently being processed for the recurring payments.

This property is read-only.

subscription_details_card_number Property

The card number currently being processed for the recurring payments.

Syntax

def get_subscription_details_card_number() -> str: ...

subscription_details_card_number = property(get_subscription_details_card_number, None)

Default Value

Remarks

The card number currently being processed for the recurring payments.

This property is read-only.

subscription_details_end_date Property

The date in which the recurring payments will stop processing.

Syntax

def get_subscription_details_end_date() -> str: ...

subscription_details_end_date = property(get_subscription_details_end_date, None)

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.

subscription_details_frequency Property

The frequency in which payments will occur.

Syntax

def get_subscription_details_frequency() -> str: ...

subscription_details_frequency = property(get_subscription_details_frequency, None)

Default Value

Remarks

The frequency in which payments will occur.

If subscription_details_frequency_unit is applicable, this property will contain the length of the corresponding subscription_details_frequency_unit 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.

subscription_details_frequency_unit Property

The unit frequency in which the payments will be processed.

Syntax

def get_subscription_details_frequency_unit() -> str: ...

subscription_details_frequency_unit = property(get_subscription_details_frequency_unit, None)

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.

subscription_details_last_payment_date Property

The date that the last/previous transaction was processed.

Syntax

def get_subscription_details_last_payment_date() -> str: ...

subscription_details_last_payment_date = property(get_subscription_details_last_payment_date, None)

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.

subscription_details_next_payment_date Property

The date of the next upcoming transaction.

Syntax

def get_subscription_details_next_payment_date() -> str: ...

subscription_details_next_payment_date = property(get_subscription_details_next_payment_date, None)

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.

subscription_details_recur_amount Property

The amount being charged on a recurring basis.

Syntax

def get_subscription_details_recur_amount() -> str: ...

subscription_details_recur_amount = property(get_subscription_details_recur_amount, None)

Default Value

Remarks

The amount being charged on a recurring basis.

This property is read-only.

subscription_details_remaining_payments Property

The total number of remaining payments until the recurring payments will stop processing.

Syntax

def get_subscription_details_remaining_payments() -> int: ...

subscription_details_remaining_payments = property(get_subscription_details_remaining_payments, None)

Default Value

Remarks

The total number of remaining payments until the recurring payments will stop processing.

This property is read-only.

subscription_details_start_date Property

The date in which the recurring payments started processing.

Syntax

def get_subscription_details_start_date() -> str: ...

subscription_details_start_date = property(get_subscription_details_start_date, None)

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.

subscription_details_status Property

The current status of the recurring subscription.

Syntax

def get_subscription_details_status() -> str: ...

subscription_details_status = property(get_subscription_details_status, None)

Default Value

Remarks

The current status of the recurring subscription.

This property is read-only.

subscription_details_subscription_id Property

Contains the Subscription or Profile Identifier for the recurring payment.

Syntax

def get_subscription_details_subscription_id() -> str: ...

subscription_details_subscription_id = property(get_subscription_details_subscription_id, None)

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.

subscription_details_subscription_name Property

Contains the name of the recurring subscription or profile.

Syntax

def get_subscription_details_subscription_name() -> str: ...

subscription_details_subscription_name = property(get_subscription_details_subscription_name, None)

Default Value

Remarks

Contains the name of the recurring subscription or profile.

This property is read-only.

subscription_details_total_payments Property

The total number of payments.

Syntax

def get_subscription_details_total_payments() -> int: ...

subscription_details_total_payments = property(get_subscription_details_total_payments, None)

Default Value

Remarks

The total number of payments.

This property is read-only.

subscription_name Property

The name of the recurring subscription or profile.

Syntax

def get_subscription_name() -> str: ...
def set_subscription_name(value: str) -> None: ...

subscription_name = property(get_subscription_name, set_subscription_name)

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.

test_mode Property

Turns test mode on and off for transactions sent to the current Gateway .

Syntax

def get_test_mode() -> bool: ...
def set_test_mode(value: bool) -> None: ...

test_mode = property(get_test_mode, set_test_mode)

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 test_mode property to True and the current gateway does not support it, the class will fails with an error.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

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

transaction_id Property

Merchant-generated transaction Id used for all transactions.

Syntax

def get_transaction_id() -> str: ...
def set_transaction_id(value: str) -> None: ...

transaction_id = property(get_transaction_id, set_transaction_id)

Default Value

Remarks

This property is used to send a merchant-generated transaction id to the gateway, if the gateway supports that feature.

add_special_field Method

Adds a special field name and the corresponding value.

Syntax

def add_special_field(name: str, value: str) -> None: ...

Remarks

Please refer to the special_field_name and special_field_value properties for more information on form variables and how they are managed.

cancel_subscription Method

Cancels or deletes a recurring payment subscription.

Syntax

def cancel_subscription(subscription_id: str) -> None: ...

Remarks

This method is used to cancel or delete a recurring subscription identified by the specified SubscriptionId.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

create_subscription Method

Creates a new recurring subscription.

Syntax

def create_subscription() -> None: ...

Remarks

This method is used to create a recurring subscription based upon the payment details entered via payment_schedule.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

get_response_var Method

Parses additional information out of the response.

Syntax

def get_response_var(name: str) -> str: ...

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 response_data may be retrieved with this get_response_var method. There are three formats for the response_data 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 response_data property contains name/value pairs, pass the name in the Name parameter and this method will return the value. For instance, if response_data contains "ResponseCode=00&FraudScore=53&ApprovalCode=123456&...", calling GetResponseVar("FraudScore") will return "53".

However, if response_data contains a delimited list, pass the index of the field you wish to receive. For instance, if response_data contains "00|53|123456|...", calling GetResponseVar("1") will return "53".

Finally, if response_data contains XML, pass the xpath to the value you wish to receive. For instance, if response_data contains "<Response><Code>00</Code><FraudScore>53</FraudScore><ApprovalCode>123456</ApprovalCode></Response>", calling GetResponseVar("/Response/FraudScore") will return "53".

get_subscription_status Method

Retrieves the status of a recurring payment subscription.

Syntax

def get_subscription_status(subscription_id: str) -> None: ...

Remarks

This method retrieves the current status of the recurring payment subscription specified via SubscriptionId. subscription_details will be populated with the details about the subscription.

interrupt Method

Interrupts the current action.

Syntax

def interrupt() -> None: ...

Remarks

This method interrupts any processing that the class is currently executing.

reset_special_fields Method

Resets all special fields to the default settings.

Syntax

def reset_special_fields() -> None: ...

Remarks

This function resets all special gateway configuration fields to the default settings for the specified gateway.

Please refer to the special_field_name and special_field_value properties for more information on form variables and how they are managed.

update_subscription Method

Updates a recurring payment subscription.

Syntax

def update_subscription(subscription_id: str) -> None: ...

Remarks

This method is used to update a recurring subscription, specified by SubscriptionId. Specify new values via payment_schedule before calling this method.

on_error Event

Information about errors during data delivery.

Syntax

class RecurringBillingErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class RecurringBilling:
@property
def on_error() -> Callable[[RecurringBillingErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[RecurringBillingErrorEventParams], None]) -> None: ...

Remarks

The on_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.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class RecurringBillingSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class RecurringBilling:
@property
def on_ssl_server_authentication() -> Callable[[RecurringBillingSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[RecurringBillingSSLServerAuthenticationEventParams], None]) -> None: ...

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.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class RecurringBillingSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class RecurringBilling:
@property
def on_ssl_status() -> Callable[[RecurringBillingSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[RecurringBillingSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

RecurringBilling Config Settings

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 payment_schedule_initial_amount and payment_schedule_recur_amount. When set to a value other than 0, the class will automatically convert the amount from the specified format to the format expected by the gateway. Valid values are:


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

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

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

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

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

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

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

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

This config is populated after a get_subscription_status 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 get_subscription_status 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: update_subscription, cancel_subscription, or get_subscription_status.

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, e_check_bank, and customer properties will be populated based on the data in the response.

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

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

The available request types are:


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

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

This config is populated after a get_subscription_status 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 get_subscription_status 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: update_subscription, cancel_subscription, or get_subscription_status.

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 shipping_info 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 subscription_details. When set to "True", calling GetSubscriptionStatus will return more details about the subscription and populate other fields in subscription_details, 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 create_subscription.

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 create_subscription and setting BASYSRequestType configuration setting to 1. This configuration setting must be set when BASYSRequestType configuration setting is set to 1 and when calling update_subscription, and cancel_subscription.

BASYSCheckInfoKey: BASYS Gateway Check Info Key.

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

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

BASYSContractKey: BASYS Gateway Contract Key.

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

BASYSCustomerKey: BASYS Gateway Customer Key.

This configuration setting is populated at the time the customer profile is created by calling create_subscription 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 update_subscription, and cancel_subscription.

BASYSCustomerStatus: Indicates the Customer Status.

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

Possible values are:


Value	Description
0	Active
1	Inactive
2	Pending
3	Clsoed

The default value is 0 (Active).

BASYSNextBillingDate: BASYS Gateway Next Billing Date.

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

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 update_subscription. BASYSContractKey must also be set to the corresponding contract key.

BASYSPaymentType: Indicates the Payment Type.

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

Possible values are:


Value	Description
0	Credit Card
1	Check/ACH

The default value is 0 (Credit Card).

BASYSRequestType: The request type for the BASYS gateway.

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

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:


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

The default value is 0 (Customer Profile).

BASYSToken: BASYS Gateway Token Value.

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

BASYSTokenMode: Indicates the Token Type.

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

Possible values are:


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

The default value is 0 (Gateway Format).

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

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

Important: Be sure to call get_subscription_status after setting BlueSnapRequestType (or after calling update_subscription 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 update_subscription. (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 get_subscription_status or update_subscription.

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, merchant_login, merchant_password, test_mode, BlueSnapVaultedShopperId, and Response fields (other than CVVResult and AVSResult, which are reset).

It is expected that you will call get_subscription_status 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:


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

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

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

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

BlueSnapVaultedShopperId: BlueSnap gateway vaulted shopper ID.

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

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

This field is used for the gateways the support International card types. Supported gateways include: Adyen, Barclay, CyberSource, FastTransact, HSBC, NetBanx, NetBilling, Orbital, PayFuse, PaymentExpress, PayPoint, PlugNPay, SagePay, SECPay, and WorldPayXML. Switch, Solo, and some Maestro cards have a 1 or 2 digit Issue number printed on the front of the card, directly following the card number. If that issue number is present, it should be set with this config setting.

CardLast4Digits: The last 4 digits of a credit card.

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

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

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

This config is currently applicable to the Heartland gateway.

CardStartMonth: Used for some international cards.

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

CardStartYear: Used for some international cards.

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

CardToken: The credit card token.

This configuration setting is used to specify the credit card token (sometimes called a "nonce") to perform a transaction.

Note that this is only valid when the gateway property is set to gwNuvei or gwSquare.

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

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

The available card types are:


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

CheckNumber: Check Number.

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

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

When set to 'true', the component will perform a checksum test on the bank_routing_number when create_subscription is called. This check helps identify errors within the specified bank_routing_number. Note that this check does not guarantee that the bank_routing_number 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 cancel_subscription method is called.

By default this setting is False; calling cancel_subscription 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: payment_schedule_start_date, payment_schedule_end_date, subscription_details_start_date, subscription_details_end_date, subscription_details_next_payment_date, and subscription_details_last_payment_date. The date must be specified and will be displayed in the format specified. The default format is: "MM/dd/yyyy".

Applicable format values are:


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

EscapeXML: Automatically escape data within XML tags.

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

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

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

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

This setting may be used to specify the date that the payment_schedule_initial_amount should be charged. The date is based on the format specified via DateFormat and must be the same as, or before payment_schedule_start_date. 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 create_subscription, update_subscription, get_subscription_status, and cancel_subscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:


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

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

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

FirstDataPayPointTransactionType: The Transaction Type for the FirstDataPayPoint gateway.

This setting defines the transaction type for the FirstDataPayPoint gateway and is applicable when calling create_subscription, update_subscription, get_subscription_status, and cancel_subscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:


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

HashAlgorithm: Algorithm used for hashing.

Certain gateways allow the request to be hashed as an additional authentication mechanism. This configuration setting controls which algorithm is used for hashing. Valid values are:


Value	Algorithm
0	MD5 (default)
1	SHA-1

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

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

Authorize.Net: The newest version of the protocol includes an optional Hash Secret, which may be used to verify that a server response is actually from an Authorize.Net server. The hash secret is concatenated with the merchant_login, response_transaction_id, and transaction_amount. This value is then hashed with the MD5 algorithm and compared to the value returned by the server. If they do not match, the class fails with an error. If the AIMHashSecret is left blank, this check will not be performed. The Server's Hash Secret may be set using the Authorize.Net online merchant interface, located at https://secure.authorize.net/.

Bank of America: This value will be the HMAC Key generated for you by the gateway. This value is required and an exception will be thrown if not specified.

BarClay and Ingenico: This value is optional and when specified 'SHASIGN' parameter will be computed and sent.

Bambora/Beanstream: If hash validation is required then set this to your hash key. HashAlgorithm will also need to be set accordingly.

Nuvei: This value is required in all transactions. The value is unique to each terminal and can be set through the online interface at "https://testpayments.nuvei.com/merchant/selfcare/".

USAePay: This value is optional and when a 'Pin' value is specified, the 'UMhash' parameter will be computed and sent.

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

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

LicenseNumber: Customer's driver's license number.

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

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

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

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

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

Possible values are:


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

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

This setting specifies an XML aggregate when creating or updating a subscription for the Litle gateway. Specifically this allows you to create, update, or delete Discounts and AddOns. Please see the Litle XML Reference Guide for further information regarding these XML fields. This setting is only used when LitleTransactionType is set to '1' and create_subscription or update_subscription 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 create_subscription, update_subscription, and cancel_subscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:


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

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 payment_schedule. Possible values are:

"MONTH" (Trial interval of one month)
"DAY" (Trial interval of one day).

MerchantCode: A gateway-supplied merchant number, code, or Id.

For the CardPointe gateway, this configuration setting is required, and should contain your Merchant Id.

For the Litle gateway, this configuration setting is required, and should contain your Merchant Id.

For the MIT gateway, this configuration setting is required, and should contain your Merchant Number (Contado).

For the Priority Payment Systems gateway, this configuration setting is required, and should contain your Merchant Id.

For the WorldPayXML gateway, this configuration setting is optional; it is only needed if you require that the "merchantCode" sent in the request be different from your merchant_login (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 update_subscription, cancel_subscription, and get_subscription_status methods for the MerchantPartners or the WorldPay Link gateways.

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

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

Valid Values:


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

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

When making a Merchant Initiated Transaction (MIT), this configuration setting should be set to true to indicate to the payment gateway that the transaction is merchant initiated. Used by the Orbital payment gateway.

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

When making a Merchant Initiated Transaction (MIT), this configuration setting can be used to specify the transaction Id of a previously successful authorization. Used by the Orbital and CyberSource payment gateways.

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

When making a Merchant Initiated Transaction (MIT), this configuration setting is used to specify the type or reason for the merchant initiated transaction. The possible values and formats for this field vary by gateway, so check the gateway's documentation for the associated values and their meanings.

MyVirtualMerchantUserId: The MyVirtualMerchant user Id as configured on VirtualMerchant.

This field is used to specify your MyVirtualMerchant user Id which is required (along with merchant_login and merchant_password) 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 create_subscription, update_subscription, get_subscription_status, and cancel_subscription. See RecurringBilling Gateway Setup and Required Properties for details. Possible values are:


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

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

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

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

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

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


"A"	Auto Generate the CustomerRefNum (customer_id)
"S"	Use CustomerRefNum (customer_id) sent in the request.
"0"	Use OrderID (invoice_number) sent in the request.
"D"	Use Comments (transaction_desc) sent in the request.

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


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

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

PayerIP: The IP address of the payer.

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

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

This field is used to specify the client code that is assigned by 3DSI. This code uniquely identifies your organization for the purpose of accessing and authenticating to the Payment WorkSuite.

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

This field is used to specify the location code that uniquely identifies a specific location that is associated with the merchant identified by the specified PaymentWorkSuiteMerchantCode.

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

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

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

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

The available transaction types are:


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

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

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

PayTraceTransactionType: The Transaction Type for the PayTrace gateway.

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


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

PayWiserCardToken: PayWiser Gateway Card Token Value.

This configuration setting is populated at the time the Token is created by calling create_subscription and setting PayWiserRequestType configuration setting to 1. This configuration setting must be set to the generated card token when calling create_subscription 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 payment_schedule 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 payment_schedule property.

Structure of PayWiserPlanPattern and PayWiserRetryPattern:

For daily recurrence:


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

Example: D20160301ZZZZZZZZ001002003

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

For weekly recurrence:


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

Example: W20160301ZZZZZZZZ001002NYNNNNN001

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

For For monthly recurrence:


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

Example: M20160301ZZZZZZZZ00100229ZZ000001

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

For For Yearly recurrence:


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

Example: Y20160301ZZZZZZZZ0010022203ZZZ000

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

PayWiserRecurringPlanId: PayWiser Recurring Plan Id.

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

PayWiserRequestType: The request type for the PayWiser gateway.

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

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:


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

The default value is 0 (Customer Profile). Option 0, 1 and 2 are only valid when create_subscription method is called. Option 3 and 4 are only valid when calling cancel_subscription 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 add_special_field method. For example:

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

PayWiserTokenReferenceId: PayWiser Gateway Token Reference Id.

This configuration setting is populated at the time the Token is created by calling create_subscription 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 create_subscription and setting PhoeniXGateRequestType configuration setting to 1. This configuration setting must be set when PhoeniXGateRequestType configuration setting is set to 1 and when calling update_subscription, and cancel_subscription.

PhoeniXGateCheckInfoKey: PhoeniXGate Gateway Check Info Key.

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

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

PhoeniXGateContractKey: PhoeniXGate Gateway Contract Key.

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

PhoeniXGateCustomerKey: PhoeniXGate Gateway Customer Key.

This configuration setting is populated at the time the customer profile is created by calling create_subscription 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 update_subscription, and cancel_subscription.

PhoeniXGateCustomerStatus: Indicates the Customer Status.

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

Possible values are:


Value	Description
0	Active
1	Inactive
2	Pending
3	Clsoed

The default value is 0 (Active).

PhoeniXGateNextBillingDate: PhoeniXGate Gateway Next Billing Date.

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

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 update_subscription. PhoeniXGateContractKey must also be set to the corresponding contract key.

PhoeniXGatePaymentType: Indicates the Payment Type.

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

Possible values are:


Value	Description
0	Credit Card
1	Check/ACH

The default value is 0 (Credit Card).

PhoeniXGateRequestType: The request type for the PhoeniXGate gateway.

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

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:


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

The default value is 0 (Customer Profile).

PhoeniXGateToken: PhoeniXGate Gateway Token Value.

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

PhoeniXGateTokenMode: Indicates the Token Type.

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

Possible values are:


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

The default value is 0 (Gateway Format).

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

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

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

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


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

Possible types are:


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

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

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


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

QBMSTransactionType: The Transaction Type for the QBMS gateway.

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


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

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 create_subscription and setting RepayRequestType configuration setting to 1. This configuration setting must be set when RepayRequestType configuration setting is set to 1 and when calling update_subscription, and cancel_subscription.

RepayCheckInfoKey: Repay Gateway Check Info Key.

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

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

RepayContractKey: Repay Gateway Contract Key.

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

RepayCustomerKey: Repay Gateway Customer Key.

This configuration setting is populated at the time the customer profile is created by calling create_subscription 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 update_subscription, and cancel_subscription.

RepayCustomerStatus: Indicates the Customer Status.

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

Possible values are:


Value	Description
0	Active
1	Inactive
2	Pending
3	Clsoed

The default value is 0 (Active).

RepayNextBillingDate: Repay Gateway Next Billing Date.

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

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 update_subscription. RepayContractKey must also be set to the corresponding contract key.

RepayPaymentType: Indicates the Payment Type.

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

Possible values are:


Value	Description
0	Credit Card
1	Check/ACH

The default value is 0 (Credit Card).

RepayRequestType: The request type for the Repay gateway.

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

See RecurringBilling Gateway Setup and Required Properties for details.

Possible values are:


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

The default value is 0 (Customer Profile).

RepayToken: Repay Gateway Token Value.

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

RepayTokenMode: Indicates the Token Type.

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

Possible values are:


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

The default value is 0 (Gateway Format).

SkipJackStatusIndex: Gets subscription details at the specified status index.

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

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 get_subscription_status, 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 get_subscription_status, 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 create_subscription is called) or deleted (when cancel_subscription is called). Possible values are:

0: Customer Details (default)
1: Customer Cards

When set to 0, the create_subscription and cancel_subscription methods will create and delete Square customer profiles.

When set to 1, the create_subscription and cancel_subscription methods will create and delete credit cards on the Square customer whose Id is specified by customer_id.

Note that, regardless of this setting:

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

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

For the Stored Credentials framework, this configuration setting should be set to true to indicate that the merchant will be storing the customer's card information. Permission should be obtained from the customer prior to storing card data. This configuration setting is used by the CyberSource gateway.

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

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

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

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

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


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

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


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

TerminalId: Terminal Id value sent in the transaction.

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

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

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

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


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

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

For the Stored Credentials framework, this configuration setting should be set to true to indicate that the merchant is using stored card information. This configuration setting is used by the CyberSource gateway.

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

The number of child attributes of the current element. The XChildren configuration options will be indexed from 0 to XChildrenCount-1.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

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

Provides the name of the x'th child element of the current element.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

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

Provides the inner text of the x'th child element of the current element.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

XElement: The name of the current element.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

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

XPath implements a subset of the XML and JSON XPath specification, allowing you to point to specific elements in the XML or JSON documents. The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location. The following are possible values for an element accessor:


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

When XPath is set to a valid path, XElement points to the name of the element, with XChildren and XText providing other properties of the element.

Example (Setting XPath for XML)


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

Example (Setting XPath for JSON)


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

XText: The text of the current element.

The current element is specified in the XPath configuration option.

This configuration option is read-only.

HTTP 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 http_version 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 local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file 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 auth_scheme 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 on_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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_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:

0 - Never
1 - Always
2 - Same Scheme

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

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

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

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table 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:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When 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 Notes

HTTP/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: Sat, 29 Oct 2017 19:43:31 GMT.

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

If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting other_headers 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 on_log event. Possible values are as follows:


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

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

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

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

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

When follow_redirects 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 http_version 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 proxy_user and proxy_password are specified, this value is calculated using the algorithm specified by proxy_auth_scheme.

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

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

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

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

UseIDNs: Whether to encode hostnames to internationalized domain names.

This 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 proxy_auto_detect 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:


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

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 local_host 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 local_host 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 local_port after the connection is established.

local_port 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 on_data_in 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 on_data_in 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:


0	IPv4 Only
1	IPv6 Only
2	IPv6 with IPv4 fallback

SSL Config Settings

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

When ssl_provider 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 on_ssl_status event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if ssl_provider 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:

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

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 on_ssl_status 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 ssl_provider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when ssl_provider is set to Platform include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when ssl_provider is set to Internal:

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 ssl_provider is set to Internal include:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

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

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

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


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.

In editions which are designed to run on Windows ssl_provider 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:

The platform provider is only available on Windows 11 / Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

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 ssl_provider 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 on_ssl_server_authentication 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 on_ssl_server_authentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication 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 ssl_provider 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: server.Config("SSLNegotiatedCipher[connId]");

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: server.Config("SSLNegotiatedCipherStrength[connId]");

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: server.Config("SSLNegotiatedCipherSuite[connId]");

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: server.Config("SSLNegotiatedKeyExchange[connId]");

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: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

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: server.Config("SSLNegotiatedVersion[connId]");

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:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

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 ssl_provider 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: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

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

TLS12SupportedGroups: The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

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

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

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

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

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

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

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

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

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

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

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

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

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

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

Socket 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:


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

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


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

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

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

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

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 url_scheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open attached_file.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

100   You cannot change the remote_port at this time. A connection is in progress.
101   You cannot change the remote_host (Server) at this time. A connection is in progress.
102   The remote_host 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 local_port at this time. A connection is in progress.
107   You cannot change the local_host at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   remote_port 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).


	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


	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 url_scheme is invalid.
	155 Range operation is not supported by server.
	156 Invalid cookie index (out of range).
	301 Interrupted.
	302 Can't open attached_file.


	100 You cannot change the remote_port at this time. A connection is in progress.
	101 You cannot change the remote_host (Server) at this time. A connection is in progress.
	102 The remote_host 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 local_port at this time. A connection is in progress.
	107 You cannot change the local_host at this time. A connection is in progress.
	112 You cannot change MaxLineLength at this time. A connection is in progress.
	116 remote_port 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.


	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.


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