E-Payment Integrator 2022 PHP Edition
Version 22.0 [Build 8593]

DirectPayment Class

Properties   Methods   Events   Config Settings   Errors  

Obtain payment through PayPal directly from a buyer's credit card.

Class Name

InPay_DirectPayment

Procedural Interface

 inpay_directpayment_open();
 inpay_directpayment_close($res);
 inpay_directpayment_register_callback($res, $id, $function);
 inpay_directpayment_get_last_error($res);
 inpay_directpayment_get_last_error_code($res);
 inpay_directpayment_set($res, $id, $index, $value);
 inpay_directpayment_get($res, $id, $index);
 inpay_directpayment_do_addcustomfield($res, $name, $value);
 inpay_directpayment_do_authorize($res);
 inpay_directpayment_do_capture($res, $authorizationid, $amount);
 inpay_directpayment_do_config($res, $configurationstring);
 inpay_directpayment_do_doevents($res);
 inpay_directpayment_do_getresponsevar($res, $name);
 inpay_directpayment_do_interrupt($res);
 inpay_directpayment_do_reset($res);
 inpay_directpayment_do_sale($res);
 inpay_directpayment_do_voidtransaction($res, $authorizationid);

Remarks

The DirectPayment class allows you to obtain payment for buyers who do not have a PayPal account. DirectPayment allows you to use your PayPal account as a gateway for any credit card. Your buyer no longer needs to have his own PayPal account.

At the time of this writing, in order to use this class you must have a PayPal Business account to accept direct payments, and you must apply to have "Website Payments Pro" activated on your account. Once that is accomplished and you have set up API access, accepting credit cards is simple. First set the User to your API name, and Password to the password for that API. Set the Signature property to the API signature you received from PayPal. Then you may set the transaction properties, such as : OrderTotal, CardNumber, CardExpMonth, CardExpYear, etc. Then call either Sale or Authorize. The Ack property will indicate the success or failure of the transaction.

After an authorization, the ResponseTransactionId should be saved and logged. This value may be used to capture or void any previous uncompleted Authorize transactions (these functions will not work for a Sale transaction, which is already considered complete).

In addition, this class also provides the results to two anti-fraud measures: Address Verification Service (AVS) and Card Verification Value (CVV) tests. The results of these tests will be stored in the ResponseAVS and ResponseCVV, respectively. Although a transaction may be authorized, it is up to the merchant to inspect these properties and determine whether or not to honor the transaction.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AckAcknowledgement code received from PayPal.
CardTypeThis property specifies the type of the credit card specified in Number .
CardCVVThree digit security code on back of card (optional).
CardExpMonthThis property contains the expiration month of the customer's credit card.
CardExpYearThis property contains the 4 digit expiration year of the customer's credit card.
CardNumberThis property contains the customer's credit card number for this transaction.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the class.
InvoiceNumberYour own invoice or tracking number.
ItemCountThe number of records in the Item arrays.
ItemAmountAmount of charged on payment.
ItemDescriptionPaypal item description for the shopping cart.
ItemNameName of the item purchased.
ItemNumberItem number set by the merchant.
ItemOptionsPaypal item options for the shopping cart.
ItemQuantityQuantity of items ordered.
ItemSalesTaxAmount of tax charged on payment.
ItemTotalSum of all the Amount s.
MerchantSessionIdYour customer session identification token.
NoteAn informational note about this settlement that will be displayed in the payer's transaction history.
OrderDescriptionDescription of items the customer is purchasing.
OrderTotalTotal amount of the order.
PasswordPassword for communicating with PayPal.
PayerCityPayer's city name.
PayerCountryCodePayer's country code.
PayerCountryNamePayer's country name.
PayerEmailEmail address of the payer.
PayerFirstNamePayer's first name.
PayerIPAddressIP address of the payer's browser as recorded in its HTTP request to your website.
PayerLastNamePayer's last name.
PayerStatePayer's state or province name.
PayerStatusIndicates whether the payer is verified or not.
PayerStreet1Payer's street address (first line).
PayerStreet2Payer's street address (second line).
PayerZipPayer's United States ZIP code or other country-specific postal code.
PaymentDateThis is the time/date stamp of payment.
PaymentExchangeRateExchange rate if a currency conversion occurred.
PaymentFeeAmountPayPal fee amount charged for the transaction.
PaymentGrossAmountThe final amount charged.
PaymentTypeIndicates whether the payment is instant or delayed.
PaymentPendingReasonThe reason the payment is pending.
PaymentSettleAmountAmount deposited in your PayPal account after a currency conversion.
PaymentStatusStatus of the payment.
PaymentTaxAmountTax charged on the transaction.
PaymentTransactionIdUnique transaction ID of the payment.
PaymentTransactionTypeThe type of transaction.
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
ResponseAmountAmount returned in the response.
ResponseAVSThe Address Verification System response code.
ResponseCVVResult of the CVV check by PayPal.
ResponseTransactionIdUnique Transaction Id of the payment.
ShippingTotalTotal shipping costs for this order.
SignatureValue to use with PayPal's Signature Authentication scheme.
SSLAcceptServerCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertEncodedThis is the certificate (PEM/base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/base64 encoded).
TaxTotalSum of tax for all items included in this order.
TimeoutA timeout for the class.
URLURL all PayPal payment transactions are posted to.
UserUser name for communicating with Paypal.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddCustomFieldThis adds a custom name-value pair to be sent with the next request.
AuthorizeThis method sends an Authorization transaction to PayPal.
CaptureCompletely or partially settles a previously authorized transaction.
ConfigSets or retrieves a configuration setting.
DoEventsProcesses events from the internal message queue.
GetResponseVarIt is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties.
InterruptInterrupt the current method.
ResetClears all properties to their default values.
SaleThis method sends a Sale transaction to PayPal.
VoidTransactionVoids a prior authorization.

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.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows 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.

AuthAccessTokenThe access token returned by the PayPal Permission Service's GetAccessToken operation.
AuthApplicationIdThe Application ID for the application making a request to the PayPal Permissions Service.
AuthAuthHeaderThe PayPal Permissions Service authentication header.
AuthAuthHeaderNameThe name of the authentication header generated with the PayPal Permissions Service.
AuthCallbackURLThe URL where PayPal will post the RequestToken and VerificationCode.
AuthorizationIdThe authorization identification number of the last payment.
AuthorizingAccountAuthorizing Account Email Address for third-party API access.
AuthPasswordAPI Password for the PayPal Permissions Service.
AuthRequestTokenThe request token used to obtain an Access Token and Token Secret from the PayPal Permissions Service.
AuthRequestURLThe URL for the PayPal Permissions Service operation being requested.
AuthScopeScope of permissions to be requested for PayPal Permissions Service.
AuthSignatureAPI Signature for the PayPal Permissions Service.
AuthTokenSecretThe token secret returned by the PayPal Permission Service's GetAccessToken operation.
AuthUsernameAPI Username for the PayPal Permissions Service.
AuthVerificationCodeThe verification code used to obtain an Access Token and Token Secret from the PayPal Permissions Service.
BuildReturns the Build number contained in the response.
ButtonSourceAdditional information for identifying transactions.
CurrencyCodeSets the type of currency in which you are accepting payments.
HandlingTotalTotal handling costs for this order.
IsPartialCaptureIndicates if this capture is for the full amount of payment you authorized.
IssueNumberIssue number of Maestro or Solo card.
ItemTotalSum of cost of all items in this order.
RawRequestReturns the raw request sent to the server.
RawResponseReturns the full response.
ResponseVersionReturns the Version number contained in the response.
ShipToCityPayer's shipping city.
ShipToCountryCodePayer's shipping country code.
ShipToNamePayer's shipping name.
ShipToPayerAddressShipping address same as billing address.
ShipToPhoneNumberPayer's shipping phone number.
ShipToStatePayer's shipping state.
ShipToStreetFirst line of the payer's shipping street address.
ShipToStreet2Second line of the payer's shipping street address.
ShipToZipPayer's shipping postal code.
StartMonthMonth that Maestro or Solo card was issued.
StartYearYear that Maestro or Solo card was issued.
VersionAllows the user to set the Version number in the request.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Ack Property (InPay_DirectPayment Class)

Acknowledgement code received from PayPal.

Object Oriented Interface


public function getAck();


Procedural Interface


inpay_directpayment_get($res, 1 );


Default Value

''

Remarks

This property will contain the acknowledgement code returned by PayPal that indicates the status of the transaction. It may contain one of the following values:

SuccessRequest processing succeeded.
FailureRequest processing failed.
SuccessWithWarningRequest processing completed successfully, but with some warning information that could be useful for the requesting application to process or record.
FailureWithWarningRequest processing failed with some error and warning information that the requesting application should process to determine causes of failure.
CustomCodeReserved for internal or future use.

This property is read-only.

Data Type

String

CardType Property (InPay_DirectPayment Class)

This property specifies the type of the credit card specified in Number .

Object Oriented Interface


public function getCardType();


public function setCardType($value);

Procedural Interface


inpay_directpayment_get($res, 2 );


inpay_directpayment_set($res, 2, $value );

Default Value

0

Remarks

This property specifies the type of the credit card specified in CardNumber.

This property contains the type of the credit card (Visa, MasterCard, Amex, etc.) specified during the current transaction.

The valid card types for this property are listed below:

ccVisa (0)Visa or Delta Card
ccMasterCard (1)MasterCard
ccDiscover (2)Discover Card
ccAMEX (3)American Express Card
ccMaestro (4)Maestro Card*
ccSolo (5)Solo Card*

* Note: CurrencyCode must equal "GBP" to use this CardType. You may set the StartMonth, StartYear, and IssueNumber required for these cards via the Config method.

This property is required.

This property is not available at design time.

Data Type

Integer

CardCVV Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getCardCVV();


public function setCardCVV($value);

Procedural Interface


inpay_directpayment_get($res, 3 );


inpay_directpayment_set($res, 3, $value );

Default Value

''

Remarks

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

This alphanumeric field 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 field which can be used to determine if the customer is actually in possession of the credit card.

Even if the CVV data is incorrect, the transaction may still be authorized. It is up to the merchant to examine the field and decide whether to honor the transaction or not.

Character length and limitations: Up to four single-byte numeric characters.

This property is optional.

This property is not available at design time.

Data Type

String

CardExpMonth Property (InPay_DirectPayment Class)

This property contains the expiration month of the customer's credit card.

Object Oriented Interface


public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface


inpay_directpayment_get($res, 4 );


inpay_directpayment_set($res, 4, $value );

Default Value

1

Remarks

This field contains the expiration month of the customer's credit card.

The valid range for this property is between 1 and 12.

This property is required.

This property is not available at design time.

Data Type

Integer

CardExpYear Property (InPay_DirectPayment Class)

This property contains the 4 digit expiration year of the customer's credit card.

Object Oriented Interface


public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface


inpay_directpayment_get($res, 5 );


inpay_directpayment_set($res, 5, $value );

Default Value

2000

Remarks

This field contains the 4 digit expiration year of the customer's credit card.

This property is required.

This property is not available at design time.

Data Type

Integer

CardNumber Property (InPay_DirectPayment Class)

This property contains the customer's credit card number for this transaction.

Object Oriented Interface


public function getCardNumber();


public function setCardNumber($value);

Procedural Interface


inpay_directpayment_get($res, 6 );


inpay_directpayment_set($res, 6, $value );

Default Value

''

Remarks

This field contains the customer's credit card number for this transaction.

Character length and limitations: numeric characters only - no spaces, dashes or punctuation. Must conform with modulo and length required by each credit card type.

This property is required.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface


inpay_directpayment_get($res, 7 );


inpay_directpayment_set($res, 7, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (InPay_DirectPayment Class)

This property determines the type of firewall to connect through.

Object Oriented Interface


public function getFirewallType();


public function setFirewallType($value);

Procedural Interface


inpay_directpayment_get($res, 8 );


inpay_directpayment_set($res, 8, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

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

Data Type

Integer

FirewallHost Property (InPay_DirectPayment Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface


public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface


inpay_directpayment_get($res, 9 );


inpay_directpayment_set($res, 9, $value );

Default Value

''

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (InPay_DirectPayment Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface


public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface


inpay_directpayment_get($res, 10 );


inpay_directpayment_set($res, 10, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (InPay_DirectPayment Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface


public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface


inpay_directpayment_get($res, 11 );


inpay_directpayment_set($res, 11, $value );

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (InPay_DirectPayment Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface


public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface


inpay_directpayment_get($res, 12 );


inpay_directpayment_set($res, 12, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (InPay_DirectPayment Class)

The current status of the class.

Object Oriented Interface


public function getIdle();


Procedural Interface


inpay_directpayment_get($res, 13 );


Default Value

true

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

InvoiceNumber Property (InPay_DirectPayment Class)

Your own invoice or tracking number.

Object Oriented Interface


public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface


inpay_directpayment_get($res, 14 );


inpay_directpayment_set($res, 14, $value );

Default Value

''

Remarks

Character length and limitations: 127 single-byte alphanumeric characters.

This property is optional.

Data Type

String

ItemCount Property (InPay_DirectPayment Class)

The number of records in the Item arrays.

Object Oriented Interface


public function getItemCount();


public function setItemCount($value);

Procedural Interface


inpay_directpayment_get($res, 15 );


inpay_directpayment_set($res, 15, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

ItemAmount Property (InPay_DirectPayment Class)

Amount of charged on payment.

Object Oriented Interface


public function getItemAmount($itemindex);


public function setItemAmount($itemindex, $value);

Procedural Interface


inpay_directpayment_get($res, 16 , $itemindex);


inpay_directpayment_set($res, 16, $value , $itemindex);

Default Value

''

Remarks

Amount of charged on payment. It must have 2 decimal places, the decimal separator must be a period (.). An example Amount is "1010.10".

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemDescription Property (InPay_DirectPayment Class)

Paypal item description for the shopping cart.

Object Oriented Interface


public function getItemDescription($itemindex);


public function setItemDescription($itemindex, $value);

Procedural Interface


inpay_directpayment_get($res, 17 , $itemindex);


inpay_directpayment_set($res, 17, $value , $itemindex);

Default Value

''

Remarks

Paypal item description for the shopping cart.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemName Property (InPay_DirectPayment Class)

Name of the item purchased.

Object Oriented Interface


public function getItemName($itemindex);


public function setItemName($itemindex, $value);

Procedural Interface


inpay_directpayment_get($res, 18 , $itemindex);


inpay_directpayment_set($res, 18, $value , $itemindex);

Default Value

''

Remarks

Name of the item purchased.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemNumber Property (InPay_DirectPayment Class)

Item number set by the merchant.

Object Oriented Interface


public function getItemNumber($itemindex);


public function setItemNumber($itemindex, $value);

Procedural Interface


inpay_directpayment_get($res, 19 , $itemindex);


inpay_directpayment_set($res, 19, $value , $itemindex);

Default Value

''

Remarks

Item number set by the merchant.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemOptions Property (InPay_DirectPayment Class)

Paypal item options for the shopping cart.

Object Oriented Interface


public function getItemOptions($itemindex);


public function setItemOptions($itemindex, $value);

Procedural Interface


inpay_directpayment_get($res, 20 , $itemindex);


inpay_directpayment_set($res, 20, $value , $itemindex);

Default Value

''

Remarks

Paypal item options for the shopping cart.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemQuantity Property (InPay_DirectPayment Class)

Quantity of items ordered.

Object Oriented Interface


public function getItemQuantity($itemindex);


public function setItemQuantity($itemindex, $value);

Procedural Interface


inpay_directpayment_get($res, 21 , $itemindex);


inpay_directpayment_set($res, 21, $value , $itemindex);

Default Value

0

Remarks

Quantity of items ordered.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

Integer

ItemSalesTax Property (InPay_DirectPayment Class)

Amount of tax charged on payment.

Object Oriented Interface


public function getItemSalesTax($itemindex);


public function setItemSalesTax($itemindex, $value);

Procedural Interface


inpay_directpayment_get($res, 22 , $itemindex);


inpay_directpayment_set($res, 22, $value , $itemindex);

Default Value

''

Remarks

Amount of tax charged on payment.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemTotal Property (InPay_DirectPayment Class)

Sum of all the Amount s.

Object Oriented Interface


public function getItemTotal();


public function setItemTotal($value);

Procedural Interface


inpay_directpayment_get($res, 23 );


inpay_directpayment_set($res, 23, $value );

Default Value

''

Remarks

This property contains the sum cost of all items in this order, and may not contain any sales tax or shipping and handling charges.

This property is optional.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

MerchantSessionId Property (InPay_DirectPayment Class)

Your customer session identification token.

Object Oriented Interface


public function getMerchantSessionId();


public function setMerchantSessionId($value);

Procedural Interface


inpay_directpayment_get($res, 24 );


inpay_directpayment_set($res, 24, $value );

Default Value

''

Remarks

PayPal records this optional session identification token as an additional means to detect possible fraud.

This property is optional.

Character length and limitations: 64 single-byte numeric characters.

Data Type

String

Note Property (InPay_DirectPayment Class)

An informational note about this settlement that will be displayed in the payer's transaction history.

Object Oriented Interface


public function getNote();


public function setNote($value);

Procedural Interface


inpay_directpayment_get($res, 25 );


inpay_directpayment_set($res, 25, $value );

Default Value

''

Remarks

Used during Capture or VoidTransaction.

This property is optional.

Character length and limits: 255 single-byte characters.

Data Type

String

OrderDescription Property (InPay_DirectPayment Class)

Description of items the customer is purchasing.

Object Oriented Interface


public function getOrderDescription();


public function setOrderDescription($value);

Procedural Interface


inpay_directpayment_get($res, 26 );


inpay_directpayment_set($res, 26, $value );

Default Value

''

Remarks

This property is optional.

Character length and limitations: 127 single-byte alphanumeric characters.

Data Type

String

OrderTotal Property (InPay_DirectPayment Class)

Total amount of the order.

Object Oriented Interface


public function getOrderTotal();


public function setOrderTotal($value);

Procedural Interface


inpay_directpayment_get($res, 27 );


inpay_directpayment_set($res, 27, $value );

Default Value

''

Remarks

This includes: sales tax applied (TaxTotal), shipping (ShippingTotal) and handling charges.

This property is required.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

Password Property (InPay_DirectPayment Class)

Password for communicating with PayPal.

Object Oriented Interface


public function getPassword();


public function setPassword($value);

Procedural Interface


inpay_directpayment_get($res, 28 );


inpay_directpayment_set($res, 28, $value );

Default Value

''

Remarks

This property is required to post messages to the PayPal URL. Do not confuse this property with your PayPal password. This password must match the API User you create from inside your PayPal account.

Data Type

String

PayerCity Property (InPay_DirectPayment Class)

Payer's city name.

Object Oriented Interface


public function getPayerCity();


public function setPayerCity($value);

Procedural Interface


inpay_directpayment_get($res, 29 );


inpay_directpayment_set($res, 29, $value );

Default Value

''

Remarks

Payer's city name.

This property is required.

Character length and limitations: 40 single-byte characters.

Data Type

String

PayerCountryCode Property (InPay_DirectPayment Class)

Payer's country code.

Object Oriented Interface


public function getPayerCountryCode();


public function setPayerCountryCode($value);

Procedural Interface


inpay_directpayment_get($res, 30 );


inpay_directpayment_set($res, 30, $value );

Default Value

'US'

Remarks

Payer's country code.

Payer's country of residence in the form of ISO standard 3166 two-character country codes.

This property is required.

Character limit: Two single-byte characters.

Data Type

String

PayerCountryName Property (InPay_DirectPayment Class)

Payer's country name.

Object Oriented Interface


public function getPayerCountryName();


Procedural Interface


inpay_directpayment_get($res, 31 );


Default Value

'US'

Remarks

Payer's country name.

This property has been deprecated.

This property is read-only.

Data Type

String

PayerEmail Property (InPay_DirectPayment Class)

Email address of the payer.

Object Oriented Interface


public function getPayerEmail();


public function setPayerEmail($value);

Procedural Interface


inpay_directpayment_get($res, 32 );


inpay_directpayment_set($res, 32, $value );

Default Value

''

Remarks

Email address of the payer.

This property is optional.

Data Type

String

PayerFirstName Property (InPay_DirectPayment Class)

Payer's first name.

Object Oriented Interface


public function getPayerFirstName();


public function setPayerFirstName($value);

Procedural Interface


inpay_directpayment_get($res, 33 );


inpay_directpayment_set($res, 33, $value );

Default Value

''

Remarks

Payer's first name.

This property is required.

Character length and limitations: 25 single-byte characters.

Data Type

String

PayerIPAddress Property (InPay_DirectPayment Class)

IP address of the payer's browser as recorded in its HTTP request to your website.

Object Oriented Interface


public function getPayerIPAddress();


public function setPayerIPAddress($value);

Procedural Interface


inpay_directpayment_get($res, 34 );


inpay_directpayment_set($res, 34, $value );

Default Value

''

Remarks

IP address of the payer's browser as recorded in its HTTP request to your website.

Character length and limitations: 15 single-byte characters, including periods, in dotted-quad format: ???.???.???.???

NOTE: PayPal records this IP address as a means to detect possible fraud.

This property is required.

Data Type

String

PayerLastName Property (InPay_DirectPayment Class)

Payer's last name.

Object Oriented Interface


public function getPayerLastName();


public function setPayerLastName($value);

Procedural Interface


inpay_directpayment_get($res, 35 );


inpay_directpayment_set($res, 35, $value );

Default Value

''

Remarks

Payer's last name.

This property is required.

Character length and limitations: 25 single-byte characters.

Data Type

String

PayerState Property (InPay_DirectPayment Class)

Payer's state or province name.

Object Oriented Interface


public function getPayerState();


public function setPayerState($value);

Procedural Interface


inpay_directpayment_get($res, 36 );


inpay_directpayment_set($res, 36, $value );

Default Value

''

Remarks

Payer's state or province name.

This property is required.

Character length and limitations: 40 single-byte characters.

Data Type

String

PayerStatus Property (InPay_DirectPayment Class)

Indicates whether the payer is verified or not.

Object Oriented Interface


public function getPayerStatus();


public function setPayerStatus($value);

Procedural Interface


inpay_directpayment_get($res, 37 );


inpay_directpayment_set($res, 37, $value );

Default Value

''

Remarks

Indicates whether the payer is verified or not.

Valid values for this property are "verified" or "unverified".

Data Type

String

PayerStreet1 Property (InPay_DirectPayment Class)

Payer's street address (first line).

Object Oriented Interface


public function getPayerStreet1();


public function setPayerStreet1($value);

Procedural Interface


inpay_directpayment_get($res, 38 );


inpay_directpayment_set($res, 38, $value );

Default Value

''

Remarks

Payer's street address (first line).

This property is required.

Character length and limitations: 100 single-byte characters.

Data Type

String

PayerStreet2 Property (InPay_DirectPayment Class)

Payer's street address (second line).

Object Oriented Interface


public function getPayerStreet2();


public function setPayerStreet2($value);

Procedural Interface


inpay_directpayment_get($res, 39 );


inpay_directpayment_set($res, 39, $value );

Default Value

''

Remarks

Payer's street address (second line).

This property is optional.

Character length and limitations: 100 single-byte characters.

Data Type

String

PayerZip Property (InPay_DirectPayment Class)

Payer's United States ZIP code or other country-specific postal code.

Object Oriented Interface


public function getPayerZip();


public function setPayerZip($value);

Procedural Interface


inpay_directpayment_get($res, 40 );


inpay_directpayment_set($res, 40, $value );

Default Value

''

Remarks

Payer's United States ZIP code or other country-specific postal code.

This property is required.

Character length and limitations: 20 single-byte characters.

Data Type

String

PaymentDate Property (InPay_DirectPayment Class)

This is the time/date stamp of payment.

Object Oriented Interface


public function getPaymentDate();


Procedural Interface


inpay_directpayment_get($res, 41 );


Default Value

''

Remarks

This is the time/date stamp of payment.

This property is read-only.

Data Type

String

PaymentExchangeRate Property (InPay_DirectPayment Class)

Exchange rate if a currency conversion occurred.

Object Oriented Interface


public function getPaymentExchangeRate();


Procedural Interface


inpay_directpayment_get($res, 42 );


Default Value

''

Remarks

Exchange rate if a currency conversion occurred.

Relevant only if you are billing in their non-primary currency. If the customer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the customer's account.

This property is read-only.

Data Type

String

PaymentFeeAmount Property (InPay_DirectPayment Class)

PayPal fee amount charged for the transaction.

Object Oriented Interface


public function getPaymentFeeAmount();


Procedural Interface


inpay_directpayment_get($res, 43 );


Default Value

''

Remarks

PayPal fee amount charged for the transaction.

This property is read-only.

Data Type

String

PaymentGrossAmount Property (InPay_DirectPayment Class)

The final amount charged.

Object Oriented Interface


public function getPaymentGrossAmount();


Procedural Interface


inpay_directpayment_get($res, 44 );


Default Value

''

Remarks

The final amount charged.

This includes any shipping and taxes from your Merchant Profile.

This property is read-only.

Data Type

String

PaymentType Property (InPay_DirectPayment Class)

Indicates whether the payment is instant or delayed.

Object Oriented Interface


public function getPaymentType();


Procedural Interface


inpay_directpayment_get($res, 45 );


Default Value

''

Remarks

Indicates whether the payment is instant or delayed.

Current list of return values: none, echeck, instant.

This property is read-only.

Data Type

String

PaymentPendingReason Property (InPay_DirectPayment Class)

The reason the payment is pending.

Object Oriented Interface


public function getPaymentPendingReason();


Procedural Interface


inpay_directpayment_get($res, 46 );


Default Value

''

Remarks

The reason the payment is pending.

The current list of possible return values for this property are:

ResponseDescription
noneNo pending reason.
addressThe payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.
echeckThe payment is pending because it was made by an eCheck that has not yet cleared.
intlThe payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview.
multi-currencyYou do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment.
PaymentReviewThe payment is under review by PayPal. Check PaymentProtectionEligibility for protection eligibility status.
verifyThe payment is pending because you are not yet verified. You must verify your account before you can accept this payment.
otherThe payment is pending for a reason other than those listed above. For more information, contact PayPal customer service.

This property is read-only.

Data Type

String

PaymentSettleAmount Property (InPay_DirectPayment Class)

Amount deposited in your PayPal account after a currency conversion.

Object Oriented Interface


public function getPaymentSettleAmount();


Procedural Interface


inpay_directpayment_get($res, 47 );


Default Value

''

Remarks

Amount deposited in your PayPal account after a currency conversion.

If there is no currency conversion, this property will remain empty.

This property is read-only.

Data Type

String

PaymentStatus Property (InPay_DirectPayment Class)

Status of the payment.

Object Oriented Interface


public function getPaymentStatus();


Procedural Interface


inpay_directpayment_get($res, 48 );


Default Value

''

Remarks

Status of the payment.

The current list of possible values for this property are:

ResponseDescription
NoneNo status.
Canceled-ReversalA reversal has been canceled.
CompletedThe payment has been completed and the funds have been added successfully to your account balance.
DeniedYou denied the payment.
FailedThe payment has failed.
PendingThe payment is pending.
RefundedYou refunded the payment.
ReversedA payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer.
ProcessedA payment has been accepted.

Note: When the returned value of this property is...

- "Canceled-Reversal": it means that a reversal has been canceled. For example, you won a dispute with the customer, and the funds for the transaction that was reversed have been returned to you.

- "Denied": this happens only if the payment was previously pending because of possible reasons described for the PendingReason element.

- "Failed": this happens only if the payment was made from your customer's bank account.

- "Pending": see the PaymentPendingReason field for more information.

This property is read-only.

Data Type

String

PaymentTaxAmount Property (InPay_DirectPayment Class)

Tax charged on the transaction.

Object Oriented Interface


public function getPaymentTaxAmount();


Procedural Interface


inpay_directpayment_get($res, 49 );


Default Value

''

Remarks

Tax charged on the transaction.

This property is read-only.

Data Type

String

PaymentTransactionId Property (InPay_DirectPayment Class)

Unique transaction ID of the payment.

Object Oriented Interface


public function getPaymentTransactionId();


Procedural Interface


inpay_directpayment_get($res, 50 );


Default Value

''

Remarks

Unique transaction ID of the payment.

This property is read-only.

Data Type

String

PaymentTransactionType Property (InPay_DirectPayment Class)

The type of transaction.

Object Oriented Interface


public function getPaymentTransactionType();


Procedural Interface


inpay_directpayment_get($res, 51 );


Default Value

''

Remarks

The type of transaction.

Current list of return values: cart, express-checkout.

This property is read-only.

Data Type

String

ProxyAuthScheme Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface


inpay_directpayment_get($res, 52 );


inpay_directpayment_set($res, 52, $value );

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

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

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface


inpay_directpayment_get($res, 53 );


inpay_directpayment_set($res, 53, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface


inpay_directpayment_get($res, 54 );


inpay_directpayment_set($res, 54, $value );

Default Value

''

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getProxyPort();


public function setProxyPort($value);

Procedural Interface


inpay_directpayment_get($res, 55 );


inpay_directpayment_set($res, 55, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getProxyServer();


public function setProxyServer($value);

Procedural Interface


inpay_directpayment_get($res, 56 );


inpay_directpayment_set($res, 56, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getProxySSL();


public function setProxySSL($value);

Procedural Interface


inpay_directpayment_get($res, 57 );


inpay_directpayment_set($res, 57, $value );

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

psAutomatic (0)Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getProxyUser();


public function setProxyUser($value);

Procedural Interface


inpay_directpayment_get($res, 58 );


inpay_directpayment_set($res, 58, $value );

Default Value

''

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ResponseAmount Property (InPay_DirectPayment Class)

Amount returned in the response.

Object Oriented Interface


public function getResponseAmount();


Procedural Interface


inpay_directpayment_get($res, 59 );


Default Value

''

Remarks

Amount returned in the response.

This should always match the value sent in OrderTotal.

This property is read-only.

Data Type

String

ResponseAVS Property (InPay_DirectPayment Class)

The Address Verification System response code.

Object Oriented Interface


public function getResponseAVS();


Procedural Interface


inpay_directpayment_get($res, 60 );


Default Value

''

Remarks

The Address Verification System response code.

This one character field contains the Address Verification System (AVS) result code. This is always returned in the server response. The AVS service is used to help detect fraud. While PayPal may authorize a payment, it is up to the merchant to check the ResponseAVS and decide whether or not to honor the transaction.

The valid AVS codes are listed in the table below.

AVS CodeMeaningMatched Details
AAddressAddress Only (no ZIP)
BInternational "A"Address only (no ZIP)
CInternational "N"None
DInternational "X"Address and Postal Code
ENot allowed for MOTO (Internet/Phone) transactionsNot applicable
FUK-specific "X"Address and Postal Code
GGlobal UnavailableNot applicable
IInternational UnavailableNot applicable
NNoNone
PPostal(International "Z")Postal Code only (no Address)
RRetryNot applicable
SService not SupportedNot applicable
UUnavailableNot applicable
WWhole ZIPNine-digit ZIP code (no Address)
XExact matchAddress and nine-digit ZIP code
YYesAddress and five-digit ZIP
ZZIPFive-digit ZIP code (no Address)
All othersErrorNot applicable

This property is read-only.

Data Type

String

ResponseCVV Property (InPay_DirectPayment Class)

Result of the CVV check by PayPal.

Object Oriented Interface


public function getResponseCVV();


Procedural Interface


inpay_directpayment_get($res, 61 );


Default Value

''

Remarks

Result of the CardCVV check by PayPal.

If a CVV value was present in the CardCVV property before authorizing the transaction, this one character field will contain the host returned Card Verification Value result code. This is used to help detect fraud. It is up to the merchant to inspect this value and determine whether or not to honor the transaction.

The following is a list of current result codes:

CVV2 CodeMeaningMatched Details
MMatchCVV2
NNo matchNone
PNot processedNot applicable
SService not SupportedNot applicable
UUnavailableNot applicable
XNo responseNot applicable
All othersErrorNot applicable

This property is read-only.

Data Type

String

ResponseTransactionId Property (InPay_DirectPayment Class)

Unique Transaction Id of the payment.

Object Oriented Interface


public function getResponseTransactionId();


Procedural Interface


inpay_directpayment_get($res, 62 );


Default Value

''

Remarks

Unique Transaction Id of the payment.

The value of this property is returned by the server when either one of the following methods is called:

- Sale. In this case, the ResponseTransactionId is your record of the transaction.

- Authorize. You will need the value of ResponseTransactionId for use as a key when capturing funds.

Character length and limitations:17 single-byte characters.

This property is read-only.

Data Type

String

ShippingTotal Property (InPay_DirectPayment Class)

Total shipping costs for this order.

Object Oriented Interface


public function getShippingTotal();


public function setShippingTotal($value);

Procedural Interface


inpay_directpayment_get($res, 63 );


inpay_directpayment_set($res, 63, $value );

Default Value

''

Remarks

This property is optional.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

Signature Property (InPay_DirectPayment Class)

Value to use with PayPal's Signature Authentication scheme.

Object Oriented Interface


public function getSignature();


public function setSignature($value);

Procedural Interface


inpay_directpayment_get($res, 64 );


inpay_directpayment_set($res, 64, $value );

Default Value

''

Remarks

A PayPal-generated unique digital signature (a line of text, or hash) that you copy from PayPal's website and include in API calls made by this class. An alternative to API Certificate security. Your digital signature, your API username, and your API password all together are called three-token authentication. An API signature is suitable for use with Microsoft Windows web servers or other shared web server configurations, such as those used by web hosting services. Multiple API signatures can be associated with your API username and password. For security, every time you view your API credential/signature on https://www.paypal.com, a new signature is generated. In your API calls, you can use any of the signatures that PayPal generates for you. All the signatures are equally valid until you remove your credentials by clicking Remove on the View API Signature page.

Data Type

String

SSLAcceptServerCertEncoded Property (InPay_DirectPayment Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface


inpay_directpayment_get($res, 66 );


inpay_directpayment_set($res, 66, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (InPay_DirectPayment Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


inpay_directpayment_get($res, 94 );


inpay_directpayment_set($res, 94, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface


inpay_directpayment_get($res, 110 );


inpay_directpayment_set($res, 110, $value );

Default Value

'MY'

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface


inpay_directpayment_get($res, 111 );


inpay_directpayment_set($res, 111, $value );

Default Value

''

Remarks

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

Data Type

String

SSLCertStoreType Property (InPay_DirectPayment Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


inpay_directpayment_get($res, 112 );


inpay_directpayment_set($res, 112, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key 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.

Data Type

Integer

SSLCertSubject Property (InPay_DirectPayment Class)

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

Object Oriented Interface


public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface


inpay_directpayment_get($res, 113 );


inpay_directpayment_set($res, 113, $value );

Default Value

''

Remarks

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

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (InPay_DirectPayment Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface


public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface


inpay_directpayment_get($res, 121 );


inpay_directpayment_set($res, 121, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.

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.

Data Type

Integer

SSLServerCertEncoded Property (InPay_DirectPayment Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLServerCertEncoded();


Procedural Interface


inpay_directpayment_get($res, 123 );


Default Value

''

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Binary String

TaxTotal Property (InPay_DirectPayment Class)

Sum of tax for all items included in this order.

Object Oriented Interface


public function getTaxTotal();


public function setTaxTotal($value);

Procedural Interface


inpay_directpayment_get($res, 150 );


inpay_directpayment_set($res, 150, $value );

Default Value

''

Remarks

This property is optional.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

Timeout Property (InPay_DirectPayment Class)

A timeout for the class.

Object Oriented Interface


public function getTimeout();


public function setTimeout($value);

Procedural Interface


inpay_directpayment_get($res, 151 );


inpay_directpayment_set($res, 151, $value );

Default Value

30

Remarks

If Timeout is set to a positive value, and an operation cannot be completed immediately, the class will retry the operation for a maximum of Timeout seconds.

The default value for Timeout is 30 (seconds).

Data Type

Integer

URL Property (InPay_DirectPayment Class)

URL all PayPal payment transactions are posted to.

Object Oriented Interface


public function getURL();


public function setURL($value);

Procedural Interface


inpay_directpayment_get($res, 152 );


inpay_directpayment_set($res, 152, $value );

Default Value

'https://api-3t.paypal.com/nvp'

Remarks

This is the URL to which the class posts requests to, and receives responses from. The server you use depends on whether you are using the "API Certificate" or the "API Signature" authentication scheme. If you use the API Certificate authentication scheme, you must set the SSLCert with your client-side certificate. If using the Signature method, set the Signature property instead. The list of valid URLs is shown below:

URLDescription
https://api.paypal.com/nvpLive server for use with the API Certificate authentication scheme.
https://api-3t.paypal.com/nvpLive server for use with the 3-token API Signature authentication scheme.
https://api.sandbox.paypal.com/nvpTest server for use with the API Certificate authentication scheme.
https://api-3t.sandbox.paypal.com/nvpTest server for use with the 3-token API Signature authentication scheme.

Data Type

String

User Property (InPay_DirectPayment Class)

User name for communicating with Paypal.

Object Oriented Interface


public function getUser();


public function setUser($value);

Procedural Interface


inpay_directpayment_get($res, 153 );


inpay_directpayment_set($res, 153, $value );

Default Value

''

Remarks

This property is required to post messages to the PayPal URL. This should not be the same username as your PayPal account login, but rather the name of the API service you've created in your account. If you allow PayPal to auto-generate the name, it is usually the first part of your email address plus "_api1." plus the last part of your email address. For instance, a PayPal Id of test@teststore.com would generate a user name test_api1.teststore.com.

Data Type

String

AddCustomField Method (InPay_DirectPayment Class)

This adds a custom name-value pair to be sent with the next request.

Object Oriented Interface

public function doAddCustomField($name, $value);

Procedural Interface

inpay_directpayment_do_addcustomfield($res, $name, $value);

Remarks

This method should be used to append a custom name-value pair to the next outgoing request to PayPal.

Note: The custom fields that have been added will be cleared by the class automatically after each request.

Authorize Method (InPay_DirectPayment Class)

This method sends an Authorization transaction to PayPal.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

inpay_directpayment_do_authorize($res);

Remarks

There are two types of transactions, Sales and Authorizations. In a Sale, the transaction is automatically captured, and funds are automatically deposited into your PayPal account.

However, in the case of an authorization (using the Authorize method), funds are not automatically captured. You must manually capture the funds with the Capture method.

Capture Method (InPay_DirectPayment Class)

Completely or partially settles a previously authorized transaction.

Object Oriented Interface

public function doCapture($authorizationid, $amount);

Procedural Interface

inpay_directpayment_do_capture($res, $authorizationid, $amount);

Remarks

This method captures the transaction indicated by the AuthorizationId parameter for the amount specified in the Amount parameter. You may capture less than the authorized amount by setting the IsPartialCapture configuration setting to True.

Config Method (InPay_DirectPayment Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inpay_directpayment_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoEvents Method (InPay_DirectPayment Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

inpay_directpayment_do_doevents($res);

Remarks

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

GetResponseVar Method (InPay_DirectPayment Class)

It is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties.

Object Oriented Interface

public function doGetResponseVar($name);

Procedural Interface

inpay_directpayment_do_getresponsevar($res, $name);

Remarks

This method allows you to retrieve additional variables from the response. The value is returned by the method. Note that the variable name is case-sensitive. component.GetResponseVar("ACK")

Interrupt Method (InPay_DirectPayment Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

inpay_directpayment_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Reset Method (InPay_DirectPayment Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

inpay_directpayment_do_reset($res);

Remarks

This method clears all properties to their default values and returns the component to its default state.

Sale Method (InPay_DirectPayment Class)

This method sends a Sale transaction to PayPal.

Object Oriented Interface

public function doSale();

Procedural Interface

inpay_directpayment_do_sale($res);

Remarks

There are two types of transactions, Sales and Authorizations. In a Sale, the transaction is automatically captured, and funds are automatically deposited into your PayPal account. However, in the case of an authorization (using the Authorize method), funds are not automatically captured. You must manually capture the funds with the Capture method.

VoidTransaction Method (InPay_DirectPayment Class)

Voids a prior authorization.

Object Oriented Interface

public function doVoidTransaction($authorizationid);

Procedural Interface

inpay_directpayment_do_voidtransaction($res, $authorizationid);

Remarks

This voids the transaction indicated by the AuthorizationId parameter.

Note: when the three-day authorization period expires, the authorization of a transaction is implicitly voided.

Error Event (InPay_DirectPayment Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inpay_directpayment_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (InPay_DirectPayment Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

inpay_directpayment_register_callback($res, 2, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
'certsubject'
'certissuer'
'status'
'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (InPay_DirectPayment Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

inpay_directpayment_register_callback($res, 3, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Config Settings (DirectPayment Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

DirectPayment Config Settings

AuthAccessToken:   The access token returned by the PayPal Permission Service's GetAccessToken operation.

After a call to the PayPal Permission Service's GetAccessToken operation, this configuration option will contain the returned Access Token. This value is required to create the PayPal Permissions Service authentication header.

AuthApplicationId:   The Application ID for the application making a request to the PayPal Permissions Service.

The Application ID provided by PayPal for your application. In the sandbox environment the static value "APP-80W284485P519543T" can be used.

AuthAuthHeader:   The PayPal Permissions Service authentication header.

After specifying a valid AuthAccessToken and AuthTokenSecret, this configuration option will contain the authentication header granting you permissions to perform the designated operations on behalf of the granting account.

AuthAuthHeaderName:   The name of the authentication header generated with the PayPal Permissions Service.

This configuration option should be set to correct header name for the PayPal Permission Service's authentication header for the desired operation. This value will usually be one of the following:

X-PP-AUTHORIZATION (default)
X-PAYPAL-AUTHORIZATION

AuthCallbackURL:   The URL where PayPal will post the RequestToken and VerificationCode.

The URL that PayPal will post the RequestToken and VerificationCode to in response to a RequestPermissions request using the PayPal Permissions Service.

AuthorizationId:   The authorization identification number of the last payment.

This value is returned in response to a Capture or VoidTransaction request. It should match the value sent in the AuthorizationId parameter of the Capture or VoidTransaction method. This config setting is read-only.

AuthorizingAccount:   Authorizing Account Email Address for third-party API access.

The email address of a third party for whom you are sending requests to the PayPal Web Services API. Your API username must have been granted permission by this third party in order to make a PayPal API request.

AuthPassword:   API Password for the PayPal Permissions Service.

The API password that is to be used when submitting requests to the PayPal Permissions Service.

AuthRequestToken:   The request token used to obtain an Access Token and Token Secret from the PayPal Permissions Service.

After a call to the RequestPermissions operation, PayPal will post this value to the AuthCallbackURL. The value posted back to the AuthCallbackURL must be set in this configuration option prior to calling the GetAccessToken operation of the PayPal Permissions Service.

AuthRequestURL:   The URL for the PayPal Permissions Service operation being requested.

The URL for the PayPal Permissions Service operation that is being requested. Examples are:

Request Permissionhttps://svcs.sandbox.paypal.com/Permissions/RequestPermissions
Get Access Tokenhttps://svcs.sandbox.paypal.com/Permissions/GetAccessToken

AuthScope:   Scope of permissions to be requested for PayPal Permissions Service.

The type of permissions that you are requesting from from a PayPal user. The following is an example of the types of permissions that can be requested, but this is not a complete list:

EXPRESS_CHECKOUT
DIRECT_PAYMENT
SETTLEMENT_CONSOLIDATION
SETTLEMENT_REPORTING
AUTH_CAPTURE
MOBILE_CHECKOUT
BILLING_AGREEMENT
REFERENCE_TRANSACTION
AIR_TRAVEL
MASS_PAY
TRANSACTION_DETAILS
TRANSACTION_SEARCH
RECURRING_PAYMENTS
ACCOUNT_BALANCE
ENCRYPTED_WEBSITE_PAYMENTS
REFUND
NON_REFERENCED_CREDIT
BUTTON_MANAGER
ACCESS_BASIC_PERSONAL_DATA
ACCESS_ADVANCED_PERSONAL_DATA
MANAGE_PENDING_TRANSACTION_STATUS
"RECURRING_PAYMENT_REPORT
EXTENDED_PRO_PROCESSING_REPORT
EXCEPTION_PROCESSING_REPORT
ACCOUNT_MANAGEMENT_PERMISSION
INVOICING

AuthSignature:   API Signature for the PayPal Permissions Service.

The API signature that is to be used when submitting requests to the PayPal Permissions Service.

AuthTokenSecret:   The token secret returned by the PayPal Permission Service's GetAccessToken operation.

After a call to the PayPal Permission Service's GetAccessToken operation, this configuration option will contain the returned Token Secret. This value is required to create the PayPal Permissions Service authentication header.

AuthUsername:   API Username for the PayPal Permissions Service.

The API username that is to be used when submitting requests to the PayPal Permissions Service.

AuthVerificationCode:   The verification code used to obtain an Access Token and Token Secret from the PayPal Permissions Service.

After a call to the RequestPermissions operation, PayPal will post this value to the AuthCallbackURL. The value posted back to the AuthCallbackURL must be set in this configuration option prior to calling the GetAccessToken operation of the PayPal Permissions Service.

Build:   Returns the Build number contained in the response.

Contains the build number returned in the response from Paypal. This config setting is read-only.

ButtonSource:   Additional information for identifying transactions.

The "BN" identification code given to you by your PayPal Account Manager for identifying transactions.

CurrencyCode:   Sets the type of currency in which you are accepting payments.

This configuration setting is used to determine the type of currency to be used for a payment. The default is "USD".

HandlingTotal:   Total handling costs for this order.

IsPartialCapture:   Indicates if this capture is for the full amount of payment you authorized.

If this configuration setting is set to False (default), and the Amount of the Capture is less than the originally authorized amount, any remaining amount of the original transaction is automatically voided.

IssueNumber:   Issue number of Maestro or Solo card.

Maximum length of two digits. Only applicable if the CardType is set to ccSolo or ccMaestro, and the CurrencyCode is "GBP".

ItemTotal:   Sum of cost of all items in this order.

RawRequest:   Returns the raw request sent to the server.

Contains the full request that was sent to PayPal in the previous call.

RawResponse:   Returns the full response.

This configuration setting will return the entire previous response as returned from the PayPal server.

ResponseVersion:   Returns the Version number contained in the response.

The server may return a different version number than was sent to it. This config setting is available for informational purposes, and is read-only.

ShipToCity:   Payer's shipping city.

Use this configuration when using a shipping address.

ShipToCountryCode:   Payer's shipping country code.

Use this configuration when using a shipping address.

ShipToName:   Payer's shipping name.

Use this configuration when using a shipping address.

ShipToPayerAddress:   Shipping address same as billing address.

If this property is set to True, the shipping address sent to PayPal will be identical to the Payer's billing address as returned after a call to GetCheckoutDetails. If you wish to send an alternate shipping address, this must be set to False (default), and the ShipToCity, ShipToCountryCode, etc. address configuration settings must contain the shipping address.

ShipToPhoneNumber:   Payer's shipping phone number.

This configuration is optional when using a shipping address.

ShipToState:   Payer's shipping state.

Use this configuration when using a shipping address.

ShipToStreet:   First line of the payer's shipping street address.

Use this configuration when using a shipping address.

ShipToStreet2:   Second line of the payer's shipping street address.

This configuration is optional when using a shipping address.

ShipToZip:   Payer's shipping postal code.

Use this configuration when using a shipping address.

StartMonth:   Month that Maestro or Solo card was issued.

Must be two digits, and zero-filled if necessary. Only applicable if the CardType is set to ccSolo or ccMaestro, and the CurrencyCode is "GBP".

StartYear:   Year that Maestro or Solo card was issued.

Must contain a four-digit year (eg: "2007"). Only applicable if the CardType is set to ccSolo or ccMaestro, and the CurrencyCode is "GBP".

Version:   Allows the user to set the Version number in the request.

This is for future compatibility. The currently supported versions are "1.0" (default) and "2.0". Any other value will cause PayPal to include a warning in the response.

HTTP Config Settings

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

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

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

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

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

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

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

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

  • 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 OtherHeaders to Connection: Keep-Alive. If False, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is False.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:

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 FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

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

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

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

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

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

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

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

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

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

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET 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 ProxyAutoDetect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser).

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

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

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

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

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect 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 LocalHost setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

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 SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

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

  • 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 SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

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

The enabled cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider 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 SSLProvider 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 SSLProvider 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.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (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 SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • 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 SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: 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:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: 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 SSLProvider 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:

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

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

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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 DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (DirectPayment Class)

DirectPayment Errors

2201   Server error response.
2202   You attempted to set a property with invalid data.
2203   You must set additional properties before attempting this function.

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

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in URL
153   Specified URLScheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open AttachedFile.

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

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2023 4D Payments Inc.
E-Payment Integrator 2022 PHP Edition - Version 22.0 [Build 8593]