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

Retail Class

Properties   Methods   Events   Config Settings   Errors  

The Retail class is used to authorize credit card transactions with any of the supported Internet Payment Gateways.

Class Name

InPay_Retail

Procedural Interface

 inpay_retail_open();
 inpay_retail_close($res);
 inpay_retail_register_callback($res, $id, $function);
 inpay_retail_get_last_error($res);
 inpay_retail_get_last_error_code($res);
 inpay_retail_set($res, $id, $index, $value);
 inpay_retail_get($res, $id, $index);
 inpay_retail_do_addspecialfield($res, $name, $value);
 inpay_retail_do_authonly($res);
 inpay_retail_do_avsonly($res);
 inpay_retail_do_capture($res, $transactionid, $captureamount);
 inpay_retail_do_config($res, $configurationstring);
 inpay_retail_do_credit($res);
 inpay_retail_do_doevents($res);
 inpay_retail_do_force($res, $voiceauthcode);
 inpay_retail_do_getresponsevar($res, $name);
 inpay_retail_do_interrupt($res);
 inpay_retail_do_refund($res, $transactionid, $refundamount);
 inpay_retail_do_reset($res);
 inpay_retail_do_resetspecialfields($res);
 inpay_retail_do_sale($res);
 inpay_retail_do_voidtransaction($res, $transactionid);

Remarks

The Retail class allows you to use multiple Internet Payment Gateways through one interface and one class. This allows for easy migration from one gateway to another, as well as quick integration into applications or web services.

The Retail class allows your website to securely perform credit card transactions without the need to redirect to a third-party site. All transactions are accomplished through a secure HTTPS Post to any supported gateway. The secure response is received and then stored in the class's response properties. Any web site on a standard HTTP server or any stand-alone application can process transactions without the need for a secure server or third-party intervention.

The first thing you must do is select one of the many gateways supported by the Retail class, and set up an account with that gateway vendor. Once you have an account set up with a valid (or test) login Id and password, you can use the Retail class.

To begin, set the Gateway property to the gateway you wish to use. If this gateway supports an alternate URL to send test transactions to, set the GatewayURL at this time.

Next, set the MerchantLogin (and for some gateways the MerchantPassword). These are supplied by your gateway vendor when you set up an account.

Now you are ready to process transactions. For each transaction, you can set the Card and TransactionAmount properties. For swiped card transactions you can set CardMagneticStripe or for manually entered transactions you can set CardNumber, CardExpMonth, CardExpYear. Most gateways will also require additional properties, such as CustomerAddress, CustomerFirstName, CustomerLastName, InvoiceNumber, etc. Any additional required properties are listed in the Gateway property description.

Once these properties are set, you may run validity checks on the card data with the AVSOnly method, or simply authorize the transaction with the Sale method. If your Gateway supports them, you may also perform a wide variety of transaction types such as VoidTransaction, Refund, Credit, or Force. Please review the method pages for further details about these methods and their designed functionality.

The following gateways are supported by the Retail class:

GatewayHome page
No Gateway (0) n/a
Authorize.Net AIM (1)http://www.authorize.net
eProcessing Transparent Database Engine (2)http://www.eProcessingNetwork.com
iTransact RediCharge HTML (4)http://www.itransact.com
NetBilling DirectMode (5)http://www.netbilling.com
PayFlow Pro (6)https://www.paypal.com/webapps/mpp/payflow-payment-gateway
USA ePay CGI Transaction Gateway (7)http://www.usaepay.com
Plug 'n Pay (8)http://www.plugnpay.com
Planet Payment iPay (9)http://planetpayment.com/
MPCS (10)http://merchantcommerce.net/
RTWare (11)http://www.rtware.net/
ECX (12)http://www.ecx.com
Bank of America (Global Gateway e4) (13)http://bankofamerica.com/merchantservices
Merchant Anywhere (Transaction Central) (15)http://www.merchantanywhere.com/
SkipJack (16)http://www.skipjack.com
TrustCommerce API (19)http://www.trustcommerce.com
PayFuse XML (ClearCommerce Engine) (21)http://www.firstnationalmerchants.com/
LinkPoint (24)http://www.linkpoint.com
Fast Transact VeloCT (Direct Mode) (27)http://www.fasttransact.com/
NetworkMerchants Direct-Post API (28)http://www.nmi.com/
TransFirst Transaction Central Classic (formerly PRIGate) (30)www.transfirst.com
Merchant Partners (Transaction Engine) (31)http://www.merchantpartners.com/
First Data Global Gateway (Linkpoint) (33)http://www.firstdata.com
YourPay (Linkpoint) (34) http://www.yourpay.com
ACH Payments AGI (35)http://www.ach-payments.com
Forte AGI / Payments Gateway AGI(36)https://www.forte.net/
Cyber Source SOAP API (37)http://www.cybersource.com
goEmerchant XML (39)http://www.goemerchant.com/
Chase Merchant Services (Linkpoint) (41)http://www.chase.com
Thompson Merchant Services NexCommerce (iTransact mode) (42)http://www.thompsonmerchant.com
TransFirst Transaction Central (44)http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate)
Sterling SPOT XML API (HTTPS POST) (45)http://www.sterlingpayment.com
PayJunction Trinity Gateway (46)http://www.payjunction.com
Elavon/NOVA/My Virtual Merchant (49)http://www.myvirtualmerchant.com
Verifi Direct-Post API (54)http://www.verifi.com
Merchant E-Solutions Payment Gateway (Trident API) (56)http://merchante-solutions.com/
PayLeap Web Services API (57)http://www.payleap.com
Worldpay XML (Direct/Invisible) (59)http://www.worldpay.com
ProPay Merchant Services API (60)http://www.propay.com
Intuit QuickBooks Merchant Services (QBMS) (61)This gateway is no longer in service. It has been replaced by Quickbooks Payments (113).
Heartland POS Gateway (62)http://www.heartlandpaymentsystems.com/
Litle Online Gateway (63)http://www.litle.com/
BrainTree DirectPost (Server-to-Server Orange) Gateway (64)http://www.braintreepaymentsolutions.com/
JetPay Gateway (65)http://www.jetpay.com/
HSBC XML API (ClearCommerce Engine) (66)https://www.business.hsbc.uk/en-gb/payments/business-card
BluePay 2.0 Post (67)http://www.bluepay.com
PayTrace Payment Gateway (70)https://www.paytrace.net/
TransNational Bankcard (74)http://www.tnbci.com/
First Data Global Gateway E4 (80)http://www.firstdata.com
Bluefin (82)http://www.bluefin.com/
Payscape (83)http://www.payscape.com
Pay Direct (Link2Gov) (84)https://www.fisglobal.com/solutions/other/government/
WorldPay US Link Gateway (87)https://www.worldpay.com/en-us/index
3DSI Payment WorkSuite (88)http://www.3dsi.com/
First Data PayPoint (90)https://www.firstdata.com/en_us/customer-center/financial-institutions/paypoint.html
Converge (formerly MyVirtualMerchant) (93)https://support.convergepay.com/s/
Payeezy Gateway (formerly First Data E4) (94)https://developer.payeezy.com/
Authorize.NET XML (96)http://www.authorize.net
PhoeniXGate Gateway (97)http://www.phoenixmanagednetworks.com/
Repay Gateway (98)https://www.repay.com/
BASYS Gateway (106)https://basyspro.com/
Quickbooks Payments (113)https://quickbooks.intuit.com/payments/
Shift4 (114)https://www.shift4.com/
PayTrace Payment Gateway JSON (117)https://www.paytrace.net/

Property List


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

AuthCodeAuthorization code from a previous transaction.
CardTypeType of credit card being used in this transaction.
CardCVVDataThree digit security code on back of card (optional).
CardCVVPresenceIndicates the presence of the card verification value.
CardEntryDataSourceThis property contains a 1-character code identifying the source of the customer data.
CardExpMonthExpiration month of the credit card specified in Number .
CardExpYearExpiration year of the credit card specified in Number .
CardIsEncryptedDetermines whether data set to the Number or MagneticStripe properties is validated.
CardMagneticStripeTrack data read off of the card's magnetic stripe.
CardNumberCustomer's credit card number for the transaction.
CustomerAddressCustomer's street address.
CustomerAddress2A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.
CustomerAggregateThis property allows you to get or set an XML aggregate built from all of the Customer properties.
CustomerCityCustomer's city.
CustomerCountryCustomer's country.
CustomerEmailCustomer's email address.
CustomerFaxCustomer's fax number.
CustomerFirstNameCustomer's first name.
CustomerFullNameCustomer's full name.
CustomerIdMerchant-generated customer Id.
CustomerLastNameCustomer's last name.
CustomerPhoneCustomer's phone number.
CustomerStateCustomer's state.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
GatewayGateway to process transactions with.
GatewayURLDefault URL for a specific Gateway .
InvoiceNumberMerchant-generated invoice number.
Level2AggregateThe level 2 aggregate containing the data to be sent in the request.
Level3AggregateThe level 3 aggregate containing the data to be sent in the request.
MerchantLoginMerchant's Gateway login.
MerchantPasswordMerchant's Gateway password.
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.
ResponseApprovalCodeContains an authorization code when a transaction has been approved.
ResponseApprovedIndicates the status of the last transaction.
ResponseApprovedAmountThe amount approved for the transaction, this is the amount actually charged to the credit card.
ResponseAVSResultContains the Address Verification System result code.
ResponseCodeIndicates the status of the authorization request.
ResponseCVVResultContains the returned CVV2 result code if it was requested.
ResponseDataThe entire response returned from the gateway processor.
ResponseErrorCodeAdditional error code returned by some gateways.
ResponseErrorTextAdditional error description returned by some gateways.
ResponseInvoiceNumberInvoice number submitted in authorization request (if applicable).
ResponseProcessorCodeResponse code from the underlying processor.
ResponseTextText information that describes each response code.
ResponseTransactionIdContains the Visa Transaction Identifier or MasterCard Reference Number.
ShippingAddressCustomer's shipping street address.
ShippingAddress2A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.
ShippingCityCustomer's shipping city.
ShippingCountryCustomer's shipping country.
ShippingEmailCustomer's email address.
ShippingFirstNameCustomer's first name.
ShippingLastNameCustomer's last name.
ShippingPhoneCustomer's phone number.
ShippingStateCustomer's shipping state.
ShippingZipCustomer's shipping zip code (or postal code if outside of the USA).
SpecialFieldCountThe number of records in the SpecialField arrays.
SpecialFieldNameName of special configuration property to submit in this transaction.
SpecialFieldValueValue of special configuration property to submit in this transaction.
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).
TestModeTurns test mode on and off for transactions sent to the current Gateway .
TimeoutA timeout for the class.
TransactionAmountPurchase amount for an authorization transaction.
TransactionDescDescription of goods purchased.
TransactionIdMerchant-generated transaction Id used for all transactions.

Method List


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

AddSpecialFieldAdds a special field name and the corresponding value.
AuthOnlyInitiates an authorization-only request transaction.
AVSOnlyUsed to check the validity of the card without authorizing funds.
CaptureCaptures a previously authorized transaction.
ConfigSets or retrieves a configuration setting.
CreditCredits a customer's card.
DoEventsProcesses events from the internal message queue.
ForceUsed when authorization cannot be obtained online.
GetResponseVarParses additional information out of the response.
InterruptInterrupts the current action.
RefundRefunds a previously captured transaction.
ResetClears all properties to their default values.
ResetSpecialFieldsResets all special fields to the default settings.
SaleInitiates an Sale transaction (authorization and capture).
VoidTransactionVoids a previously authorized transaction.

Event List


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

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.

3DSAuthenticationStatusIndicates whether a transaction qualifies as a ThreeDSecure (3DS) authenticated transaction.
3DSCAVVCardholder Authentication Verification Value from a 3D Secure authentication.
3DSDSTransactionIdDirectory server transaction Id from a 3D Secure authentication.
3DSECIElectronic Commerce Indicator.
3DSEnrollmentStatusIndicates whether 3D Secure authentication is available for the cardholder.
3DSXIDTransactionId from a 3D Secure authentication.
AllowPartialAuthsSpecifies whether partial authorizations are allowed.
AmountFormatUsed to set the input format for TransactionAmount.
ApplePayDataThe Base-64 encoded data containing the encrypted payment data from Apple for use when performing Apple Pay transactions.
AuthNetShipToCompanyThe name of the company associated with the customer's shipping address.
AuthNetSplitTenderIdAuthorize.Net assigned id for partially authorized transactions.
BluePayKSNThe Key Serial Number (KSN) used to encrypt the card magnetic stripe data for the BluePay gateway.
BluePayMasterIdUsed to reference a previous transaction in BluePay.
BluePayPreEncryptedTrackLengthThe length of the magnetic stripe data prior to encryption for the BluePay gateway.
BluePayUpdateUsed to perform an Update transaction for BluePay.
CardEncryptedSpecifies whether the card magnetic stripe data is encrypted.
CardholderPresentCodeSpecifies the way in which transaction took place.
CardIssueNumberSpecial Issue Number used for Switch and Solo cards.
CardPresentSpecifies whether the card is present during the transaction.
CardStartMonthUsed for some international cards.
CardStartYearUsed for some international cards.
CardTypeType of credit card being used in this transaction.
CAVVResponseContains CAVV response value returned by the gateway.
COFPermissionIndicates if the customer gave permission to make a Card On File transaction.
ConvenienceFeeThe total convenience fee charged for a transaction.
CurrencyCodeCurrency code for the currency of the transaction.
CurrencyExponentCurrency exponent to be used in conjunction with the Currency code of the transaction.
CyberSourceAuthTokenThe request token from a previous authorization for the CyberSource gateway.
CyberSourceProfileIdThe Id of a Customer's Profile stored within the CyberSource gateway.
CyberSourceVoidModeIndicates whether to perform a Void or Reversal.
CyberSourceXMLEscapeDetermines whether to XML escape the CyberSource gateway request field values.
DebitKSNClear-text Key Sequence Number retrieved from a PIN pad.
DebitPINDUKPT DES encrypted pin block, retrieved from a PIN pad.
DynamicDescriptorA merchant defined transaction description which appears on the customer's credit card statement.
EscapeXMLAutomatically escape data within XML tags.
FDMSCurrentBalanceContains the current card balance value returned in a response for the First Data E4, Payeezy, and Bank Of America gateways.
FDMSGiftCardTransactionTypeSpecifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways.
FDMSKeyIdThe Key Id that corresponds to the HMAC Key for the First Data E4, Payeezy, and Bank Of America gateways.
FDMSProcessGiftCardSpecifies whether the card being processed is a gift card for the First Data E4, Payeezy, and Bank Of America gateways.
FDMSTransArmorTokenThe Transarmor token that replaces a card number and used for transaction processing.
FDMSWalletProviderIdSpecifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways.
GlobalIrisRefundPasswordThe Refund password for the Global Iris gateway.
GoEMerchantUseGatewayIdIndicates whether to send a password or gateway Id for the GoEMerchant gateway.
HashAlgorithmAlgorithm used for hashing.
HashSecretSecurity key used to generate a hash for gateways supporting such functionality.
HeartlandDeveloperIdOptional DeveloperId field used by the Heartland gateway.
HeartlandDeviceIdDeviceId field required by the Heartland gateway.
HeartlandLicenseIdLicenseId field required by the Heartland gateway.
HeartlandReversalAmountThe settlement amount to be used when performing a reversal for the Heartland gateway.
HeartlandSecretAPIKeySpecifies the secret key to be used for authentication with Heartland.
HeartlandShipDayShip day field required by the Heartland gateway e-commerce/direct marketing transactions.
HeartlandShipMonthShip month field required by the Heartland gateway e-commerce/direct marketing transactions.
HeartlandSiteIdSiteId field required by the Heartland gateway.
HeartlandSiteTraceOptional transaction identifier for the Heartland gateway.
HeartlandTokenMappingThe type of token to return when using Tokenization with the Heartland gateway.
HeartlandTokenValueUsed to retrieve or specify a Heartland token value.
HeartlandVersionNumberOptional VersionNumber field used by the Heartland gateway.
LitleAdvancedFraudChecksIdUsed to specify the Id for use in the AdvancedFraudChecks element for the Litle gateway.
LitleCardholderIDDescribes the method used to identify the cardholder at the point of sale for the Litle gateway.
LitleCustomBillingAggregateUsed to specify an XML aggregate for Custom Billing support within the Litle gateway.
MerchantAliasAn additional merchant property used to specify an alias for the merchant.
MerchantCodeA gateway-supplied merchant number, code, or Id.
MerchantPartnersLast4DigitsThe last 4 digits of the card number for a transaction processed via the MerchantPartners gateway.
MerchantPartnersProfileIdThe profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways.
MerchantPartnersReaderTypeThe reader type used to read and encrypt a swiped card for the MerchantPartners or WorldPay Link gateways.
MITAESSeedIdThe Seed Id used to perform AES encryption for the MIT gateway.
MITBranchIdBranch reference number for the MIT gateway.
MITCompanyIdCompany reference number for the MIT gateway.
MITCountryCountry of operation for the MIT gateway.
MITEncryptionAlgorithmThe Encryption Algorithm to use with the MIT gateway.
MITEncryptionKeyThe Encryption Key to use with the MIT gateway.
MITFlagFor the MIT framework - Used to indicate that a transaction is merchant initiated.
MITPriorTransIdFor the MIT framework - Used to specify a prior transaction id to be referenced in a merchant initiated transaction.
MITRecurringSpecifies whether to perform a recurring transaction request for the MIT gateway.
MITTPOperationThe operation type for the MIT gateway.
MITTypeFor the MIT framework - Indicates the type of transaction being requested in a Merchant-Initiated Transaction (MIT).
MonerisNVPAPIIndicates whether to use the NVP API for the gwMoneris and gwMonerisUSA gateway.
MyVirtualMerchantTransactionTypeUsed to override the transaction type to send in a transaction for the MyVirtualMerchant and Converge gateways.
MyVirtualMerchantUserIdThe MyVirtualMerchant user Id as configured on VirtualMerchant.
NetbanxAccountNumberAccount Number for the Netbanx gateway.
NetBillingVersionThe Version to be sent in the User-Agent heading of a NetBilling gateway request.
OrbitalAuthReversalIndicates whether to perform an authorization reversal when calling VoidTransaction for the Orbital gateway.
OrbitalConnectionPasswordOrbital Connection Password field used by the Orbital gateway.
OrbitalConnectionUsernameOrbital Connection Username field used by the Orbital gateway.
OrbitalCustomerProfileFromOrderIndCustomer Profile Number generation Options for the Orbital gateway.
OrbitalCustomerProfileOrderOverrideIndIndicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway.
OrbitalTxRefIdxIndentifies the unique classes of transactions that have been adjusted more than one time for the Orbital gateway.
OrbitalVoidAdjustedAmountSpecifies the amount to void from a previous authoization for the Orbital gateway.
PayDirectConvenienceFeeThe total convenience fee charged when using the PayDirect gateway.
PayDirectMerchantAmountThe MerchantAmount used by the PayDirect gateway.
PayDirectSettleMerchantCodeThe Settle Merchant Code required for authorization when using the PayDirect gateway.
PayerIPThe IP address of the payer.
PayFlowProInquirySubmits an Inquiry transaction to the PayFlowPro gateway.
PayFlowProTokenUsed specify a token to be used instead of card data for the Payflow Pro gateway.
PayFlowProUploadSubmits an Upload transaction to the PayFlowPro gateway.
PayJunctionUpdateAmountIndicates whether the capture method should send an update amount request when using the PayJunction gateway.
PaymentWorkSuiteClientCodeThe 3DSI assigned client code sent in a request to the PaymentWorksuite gateway.
PaymentWorkSuiteLocationCodeThe 3DSI assigned location code sent in a request to the PaymentWorksuite gateway.
PaymentWorkSuiteMerchantCodeThe 3DSI assigned merchant code sent in a request to the PaymentWorksuite gateway.
PayPointFreedomAPIIndicates whether to use the Freedom API for the gwPayPoint and gwSECPay gateways.
PayTraceAddPurchaseCardDataSends a Level3 request for the PayTrace gateway.
PayTraceIntegratorIdUsed to specify the Integrator Id value assigned by the PayTrace gateway.
PayTraceJSONCardTokenThe token value for a corresponding card.
PayTraceJSONEncryptionKeyThe Encryption Key to use with the PayTraceJSON gateway.
PayTraceJSONGetClientKeyTokenRetrieves a new Client Key (PROTECT AUTH TOKEN) from PayTrace.
PKPaymentTokenUsed to send an Apple Pay PKPaymentToken to the gateway.
QBMSMobileWhether or not this transaction is being sent from a mobile device.
QBPaymentsMobileWhether or not this transaction is being sent from a mobile device.
RawRequestReturns the data that was sent to the gateway.
RawResponseReturns the data that was received from the gateway.
RecurringIndicatorMarks a request as a recurring transaction.
SagePayCreateTokenSends a create token request to the SagePay gateway.
SagePayRemoveTokenSends a remove token request to the SagePay gateway.
SagePayRepeatPerforms a Repeat transaction for the SagePay gateway.
SagePayRequestTokenSpecifies whether to request a token when performing an Auth or Sale when using the SagePay gateway.
SagePayStoreTokenSpecifies whether to store a token when using the SagePay gateway.
SagePayTokenThe token value for a corresponding card when using the SagePay gateway.
SagePayUseAbortIndicates whether to use Abort or Void for void transactions.
Shift4AuthTokenSpecifies the Auth Token when making an Access Token request to the Shift4 gateway.
Shift4ClientGuidSpecifies the Client Guid when making an Access Token request to the Shift4 gateway.
Shift4GetAccessTokenPerforms an Access Token Exchange request with the Shift4 gateway.
Shift4InterfaceNameSpecifies the name of the interface for the Shift4 gateway.
Shift4InterfaceVersionSpecifies the version of the interface for the Shift4 gateway.
StoreCardOnFileFor the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF).
SurchargeAmountUsed to specify the amount of the surcharge for the transaction.
TerminalCapabilityThe capability of the terminal that is used to submit the transaction.
TerminalIdTerminal Id value sent in the transaction.
TerminalManufacturerThe manufacturer of the terminal used to submit the transaction.
TerminalModelThe model of the terminal used to submit the transaction.
TerminalTypeThe terminal type that is used to submit the transaction.
TipAmountUsed to specify the amount of the tip for the transaction.
USAEPayPerformVoidReleaseSpecifies whether to perform a void or void:release transaction.
UseCardOnFileFor the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request.
UserIdUsed to specify an Id for the API user.
XChildrenCountThe number of child elements of the current element.
XChildrenName[x]The name of the child element.
XChildrenXText[x]The inner text of the child element.
XElementThe name of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XTextThe text of the current element.
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.

AuthCode Property (InPay_Retail Class)

Authorization code from a previous transaction.

Object Oriented Interface


public function getAuthCode();


public function setAuthCode($value);

Procedural Interface


inpay_retail_get($res, 1 );


inpay_retail_set($res, 1, $value );

Default Value

''

Remarks

Some gateways require the merchant to include the ResponseApprovalCode from the original transaction in Credit, VoidTransaction, and Capture transactions. You may send the original approval code in this AuthCode property. The gateways which require this are listed below:

  • gwIntellipay (3)
  • gwBankOfAmerica (13)
  • gwInnovative (14)
  • gwACHPAyments (35)
  • gwForte (36)
  • gwSagePay (50)
  • gwDataCash (77)
  • gwFirstDataE4 (80)

Data Type

String

CardType Property (InPay_Retail Class)

Type of credit card being used in this transaction.

Object Oriented Interface


public function getCardType();


public function setCardType($value);

Procedural Interface


inpay_retail_get($res, 2 );


inpay_retail_set($res, 2, $value );

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

ctUnknown (0) Invalid or unknown prefix, card type not known.
ctVisa (1) Visa or Delta Card.
ctMasterCard (2) MasterCard.
ctAMEX (3) American Express Card.
ctDiscover (4) Discover Card.
ctDiners (5) Diners Club or Carte Blanche Card.
ctJCB (6) JCB Card.
ctVisaElectron (7) Visa Electron Card (runs as a Visa for most gateways)
ctMaestro (8) Maestro Card
ctLaser (10) Laser Card (Ireland)

This property is not available at design time.

Data Type

Integer

CardCVVData Property (InPay_Retail Class)

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

Object Oriented Interface


public function getCardCVVData();


public function setCardCVVData($value);

Procedural Interface


inpay_retail_get($res, 3 );


inpay_retail_set($res, 3, $value );

Default Value

''

Remarks

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

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the CardCVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (InPay_Retail Class)

Indicates the presence of the card verification value.

Object Oriented Interface


public function getCardCVVPresence();


public function setCardCVVPresence($value);

Procedural Interface


inpay_retail_get($res, 4 );


inpay_retail_set($res, 4, $value );

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

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

Available values are:

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

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (InPay_Retail Class)

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

Object Oriented Interface


public function getCardEntryDataSource();


public function setCardEntryDataSource($value);

Procedural Interface


inpay_retail_get($res, 5 );


inpay_retail_set($res, 5, $value );

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

edsTrack1 (0) Full Magnetic stripe read and transmit, Track 1.
edsTrack2 (1) Full magnetic stripe read and transmit, Track 2.
edsManualEntryTrack1Capable (2) Manually keyed, Track 1 capable.
edsManualEntryTrack2Capable (3)Manually keyed, Track 2 capable.
edsManualEntryNoCardReader (4)Manually keyed, terminal has no card reading capability (use this for e-commerce and MOTO transactions).
edsTrack2Contactless (6)Full magnetic stripe read (Track 2 only), Chip Card capable terminal (Visa, Mastercard, and JCB Transactions only).
edsManualEntryContactlessCapable (7)Manually keyed, Chip Card read capable terminal (Visa, MasterCard, and JCB transactions only).

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (InPay_Retail Class)

Expiration month of the credit card specified in Number .

Object Oriented Interface


public function getCardExpMonth();


public function setCardExpMonth($value);

Procedural Interface


inpay_retail_get($res, 6 );


inpay_retail_set($res, 6, $value );

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardExpYear Property (InPay_Retail Class)

Expiration year of the credit card specified in Number .

Object Oriented Interface


public function getCardExpYear();


public function setCardExpYear($value);

Procedural Interface


inpay_retail_get($res, 7 );


inpay_retail_set($res, 7, $value );

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (InPay_Retail Class)

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

Object Oriented Interface


public function getCardIsEncrypted();


public function setCardIsEncrypted($value);

Procedural Interface


inpay_retail_get($res, 8 );


inpay_retail_set($res, 8, $value );

Default Value

false

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (InPay_Retail Class)

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

Object Oriented Interface


public function getCardMagneticStripe();


public function setCardMagneticStripe($value);

Procedural Interface


inpay_retail_get($res, 9 );


inpay_retail_set($res, 9, $value );

Default Value

''

Remarks

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

If CardEntryDataSource is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

This property is not available at design time.

Data Type

String

CardNumber Property (InPay_Retail Class)

Customer's credit card number for the transaction.

Object Oriented Interface


public function getCardNumber();


public function setCardNumber($value);

Procedural Interface


inpay_retail_get($res, 10 );


inpay_retail_set($res, 10, $value );

Default Value

''

Remarks

Customer's credit card number for the transaction.

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

This property is not available at design time.

Data Type

String

CustomerAddress Property (InPay_Retail Class)

Customer's street address.

Object Oriented Interface


public function getCustomerAddress();


public function setCustomerAddress($value);

Procedural Interface


inpay_retail_get($res, 11 );


inpay_retail_set($res, 11, $value );

Default Value

''

Remarks

Customer's street address. This property is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in This property. City, state, and zip code are set in the CustomerCity, CustomerState, and CustomerZip properties.

The length of this property varies by gateway. If the customer's address is very long, it is admissible to include only the street number in This property.

NOTE: For the Moneris gateway, this property should contain only the customer's street number. The street name should be added via the AddSpecialField method. For example:

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

This property is not available at design time.

Data Type

String

CustomerAddress2 Property (InPay_Retail Class)

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

Object Oriented Interface


public function getCustomerAddress2();


public function setCustomerAddress2($value);

Procedural Interface


inpay_retail_get($res, 12 );


inpay_retail_set($res, 12, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

CustomerAggregate Property (InPay_Retail Class)

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

Object Oriented Interface


public function getCustomerAggregate();


public function setCustomerAggregate($value);

Procedural Interface


inpay_retail_get($res, 13 );


inpay_retail_set($res, 13, $value );

Default Value

''

Remarks

This property allows you to get or set an XML aggregate built from all of the Customer properties. "EPCustomer" is the root element. The Customer properties make up the tags under the root, but without the beginning "Customer". For instance: <EPCustomer> <Address>123 Nowhere Ln.</Address> <Address2>Apt 3B.</Address2> <City>Beverly Hills</City> ... </EPCustomer>

This property is not available at design time.

Data Type

String

CustomerCity Property (InPay_Retail Class)

Customer's city.

Object Oriented Interface


public function getCustomerCity();


public function setCustomerCity($value);

Procedural Interface


inpay_retail_get($res, 14 );


inpay_retail_set($res, 14, $value );

Default Value

''

Remarks

Customer's city. This property is used as part of the Address Verification Service (AVS) and contains the customer's city as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerState, and CustomerZip.

This property is not available at design time.

Data Type

String

CustomerCountry Property (InPay_Retail Class)

Customer's country.

Object Oriented Interface


public function getCustomerCountry();


public function setCustomerCountry($value);

Procedural Interface


inpay_retail_get($res, 15 );


inpay_retail_set($res, 15, $value );

Default Value

''

Remarks

Customer's country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.

Note: If using this property with the PayFuse gateway, this property should contain the ISO-3166 numeric code instead of the standard two-letter code. For example, the ISO code for the US is "840".

This property is not available at design time.

Data Type

String

CustomerEmail Property (InPay_Retail Class)

Customer's email address.

Object Oriented Interface


public function getCustomerEmail();


public function setCustomerEmail($value);

Procedural Interface


inpay_retail_get($res, 16 );


inpay_retail_set($res, 16, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

CustomerFax Property (InPay_Retail Class)

Customer's fax number.

Object Oriented Interface


public function getCustomerFax();


public function setCustomerFax($value);

Procedural Interface


inpay_retail_get($res, 17 );


inpay_retail_set($res, 17, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

CustomerFirstName Property (InPay_Retail Class)

Customer's first name.

Object Oriented Interface


public function getCustomerFirstName();


public function setCustomerFirstName($value);

Procedural Interface


inpay_retail_get($res, 18 );


inpay_retail_set($res, 18, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

CustomerFullName Property (InPay_Retail Class)

Customer's full name.

Object Oriented Interface


public function getCustomerFullName();


public function setCustomerFullName($value);

Procedural Interface


inpay_retail_get($res, 19 );


inpay_retail_set($res, 19, $value );

Default Value

''

Remarks

Customer's full name. This property contains the customer's full name as it appears on the credit card or bank account. Many gateways use this property in addition to, or instead of, the CustomerFirstName and CustomerLastName properties. If a gateway requires a CustomerFullName and the property is empty, CustomerFullName will be constructed using the contents of CustomerFirstName and CustomerLastName.

This property is not available at design time.

Data Type

String

CustomerId Property (InPay_Retail Class)

Merchant-generated customer Id.

Object Oriented Interface


public function getCustomerId();


public function setCustomerId($value);

Procedural Interface


inpay_retail_get($res, 20 );


inpay_retail_set($res, 20, $value );

Default Value

''

Remarks

Merchant-generated customer Id. This property contains a merchant-generated customer identification number. This number should be unique for each different customer that places an order with the merchant.

This property is not available at design time.

Data Type

String

CustomerLastName Property (InPay_Retail Class)

Customer's last name.

Object Oriented Interface


public function getCustomerLastName();


public function setCustomerLastName($value);

Procedural Interface


inpay_retail_get($res, 21 );


inpay_retail_set($res, 21, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

CustomerPhone Property (InPay_Retail Class)

Customer's phone number.

Object Oriented Interface


public function getCustomerPhone();


public function setCustomerPhone($value);

Procedural Interface


inpay_retail_get($res, 22 );


inpay_retail_set($res, 22, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

CustomerState Property (InPay_Retail Class)

Customer's state.

Object Oriented Interface


public function getCustomerState();


public function setCustomerState($value);

Procedural Interface


inpay_retail_get($res, 23 );


inpay_retail_set($res, 23, $value );

Default Value

''

Remarks

Customer's state. This property is used as part of the Address Verification Service (AVS) and contains the two character postal abbreviation of the customer's state as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerZip.

This property is not available at design time.

Data Type

String

CustomerZip Property (InPay_Retail Class)

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

Object Oriented Interface


public function getCustomerZip();


public function setCustomerZip($value);

Procedural Interface


inpay_retail_get($res, 24 );


inpay_retail_set($res, 24, $value );

Default Value

''

Remarks

Customer's zip code (or postal code if outside of the USA). This property is used as part of the Address Verification Service (AVS), and contains the customer's zip code as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerState.

This property is not available at design time.

Data Type

String

Gateway Property (InPay_Retail Class)

Gateway to process transactions with.

Object Oriented Interface


public function getGateway();


public function setGateway($value);

Procedural Interface


inpay_retail_get($res, 25 );


inpay_retail_set($res, 25, $value );

Default Value

0

Remarks

This property is used to select the gateway with which transactions will be processed. Setting the Gateway property will also fill the GatewayURL, SpecialFieldName, and SpecialFieldValue properties with default data for the selected gateway. The following table shows the currently supported gateways, as well as the corporate home page for each.

GatewayHome page
No Gateway (0) n/a
Authorize.Net AIM (1)http://www.authorize.net
eProcessing Transparent Database Engine (2)http://www.eProcessingNetwork.com
iTransact RediCharge HTML (4)http://www.itransact.com
NetBilling DirectMode (5)http://www.netbilling.com
PayFlow Pro (6)https://www.paypal.com/webapps/mpp/payflow-payment-gateway
USA ePay CGI Transaction Gateway (7)http://www.usaepay.com
Plug 'n Pay (8)http://www.plugnpay.com
Planet Payment iPay (9)http://planetpayment.com/
MPCS (10)http://merchantcommerce.net/
RTWare (11)http://www.rtware.net/
ECX (12)http://www.ecx.com
Bank of America (Global Gateway e4) (13)http://bankofamerica.com/merchantservices
Merchant Anywhere (Transaction Central) (15)http://www.merchantanywhere.com/
SkipJack (16)http://www.skipjack.com
TrustCommerce API (19)http://www.trustcommerce.com
PayFuse XML (ClearCommerce Engine) (21)http://www.firstnationalmerchants.com/
LinkPoint (24)http://www.linkpoint.com
Fast Transact VeloCT (Direct Mode) (27)http://www.fasttransact.com/
NetworkMerchants Direct-Post API (28)http://www.nmi.com/
TransFirst Transaction Central Classic (formerly PRIGate) (30)www.transfirst.com
Merchant Partners (Transaction Engine) (31)http://www.merchantpartners.com/
First Data Global Gateway (Linkpoint) (33)http://www.firstdata.com
YourPay (Linkpoint) (34) http://www.yourpay.com
ACH Payments AGI (35)http://www.ach-payments.com
Forte AGI / Payments Gateway AGI(36)https://www.forte.net/
Cyber Source SOAP API (37)http://www.cybersource.com
goEmerchant XML (39)http://www.goemerchant.com/
Chase Merchant Services (Linkpoint) (41)http://www.chase.com
Thompson Merchant Services NexCommerce (iTransact mode) (42)http://www.thompsonmerchant.com
TransFirst Transaction Central (44)http://www.transfirst.com. (This is different from TransFirst eLink, supported above. The TransactionCentral gateway is also used by MerchantAnywhere and PRIGate)
Sterling SPOT XML API (HTTPS POST) (45)http://www.sterlingpayment.com
PayJunction Trinity Gateway (46)http://www.payjunction.com
Elavon/NOVA/My Virtual Merchant (49)http://www.myvirtualmerchant.com
Verifi Direct-Post API (54)http://www.verifi.com
Merchant E-Solutions Payment Gateway (Trident API) (56)http://merchante-solutions.com/
PayLeap Web Services API (57)http://www.payleap.com
Worldpay XML (Direct/Invisible) (59)http://www.worldpay.com
ProPay Merchant Services API (60)http://www.propay.com
Intuit QuickBooks Merchant Services (QBMS) (61)This gateway is no longer in service. It has been replaced by Quickbooks Payments (113).
Heartland POS Gateway (62)http://www.heartlandpaymentsystems.com/
Litle Online Gateway (63)http://www.litle.com/
BrainTree DirectPost (Server-to-Server Orange) Gateway (64)http://www.braintreepaymentsolutions.com/
JetPay Gateway (65)http://www.jetpay.com/
HSBC XML API (ClearCommerce Engine) (66)https://www.business.hsbc.uk/en-gb/payments/business-card
BluePay 2.0 Post (67)http://www.bluepay.com
PayTrace Payment Gateway (70)https://www.paytrace.net/
TransNational Bankcard (74)http://www.tnbci.com/
First Data Global Gateway E4 (80)http://www.firstdata.com
Bluefin (82)http://www.bluefin.com/
Payscape (83)http://www.payscape.com
Pay Direct (Link2Gov) (84)https://www.fisglobal.com/solutions/other/government/
WorldPay US Link Gateway (87)https://www.worldpay.com/en-us/index
3DSI Payment WorkSuite (88)http://www.3dsi.com/
First Data PayPoint (90)https://www.firstdata.com/en_us/customer-center/financial-institutions/paypoint.html
Converge (formerly MyVirtualMerchant) (93)https://support.convergepay.com/s/
Payeezy Gateway (formerly First Data E4) (94)https://developer.payeezy.com/
Authorize.NET XML (96)http://www.authorize.net
PhoeniXGate Gateway (97)http://www.phoenixmanagednetworks.com/
Repay Gateway (98)https://www.repay.com/
BASYS Gateway (106)https://basyspro.com/
Quickbooks Payments (113)https://quickbooks.intuit.com/payments/
Shift4 (114)https://www.shift4.com/
PayTrace Payment Gateway JSON (117)https://www.paytrace.net/

Data Type

Integer

GatewayURL Property (InPay_Retail Class)

Default URL for a specific Gateway .

Object Oriented Interface


public function getGatewayURL();


public function setGatewayURL($value);

Procedural Interface


inpay_retail_get($res, 26 );


inpay_retail_set($res, 26, $value );

Default Value

''

Remarks

This property is used to change the default URL for a specific Gateway. This is useful for specifying a different URL for testing purposes, or to support additional gateway processors that share a protocol format (such as additional Authorize.net compatible gateways). Please note that the proper "http://" or "https://" formatting must be observed. See "Testing Information" in the Table of Contents for a list of test URLs.

Data Type

String

InvoiceNumber Property (InPay_Retail Class)

Merchant-generated invoice number.

Object Oriented Interface


public function getInvoiceNumber();


public function setInvoiceNumber($value);

Procedural Interface


inpay_retail_get($res, 27 );


inpay_retail_set($res, 27, $value );

Default Value

''

Remarks

This field contains a merchant-generated invoice number. This number should be unique for each transaction. This property is optional for most gateways, but it is recommended that the merchant use an invoice number to keep track of transactions. See the Gateway property to determine if this is a required or optional field for the gateway you are using.

Data Type

String

Level2Aggregate Property (InPay_Retail Class)

The level 2 aggregate containing the data to be sent in the request.

Object Oriented Interface


public function getLevel2Aggregate();


public function setLevel2Aggregate($value);

Procedural Interface


inpay_retail_get($res, 28 );


inpay_retail_set($res, 28, $value );

Default Value

''

Remarks

This property is used to specify the level 2 aggregate obtained from Level2 class. When specified, the class will parse the aggregate and send the specified values within the transaction request to process the transaction as a level 2 transaction.

Data Type

String

Level3Aggregate Property (InPay_Retail Class)

The level 3 aggregate containing the data to be sent in the request.

Object Oriented Interface


public function getLevel3Aggregate();


public function setLevel3Aggregate($value);

Procedural Interface


inpay_retail_get($res, 29 );


inpay_retail_set($res, 29, $value );

Default Value

''

Remarks

This property is used to specify the level 3 aggregate obtained from Level3 class. When specified, the class will parse the aggregate and send the specified values within the transaction request to process the transaction as a level 3 transaction.

Data Type

String

MerchantLogin Property (InPay_Retail Class)

Merchant's Gateway login.

Object Oriented Interface


public function getMerchantLogin();


public function setMerchantLogin($value);

Procedural Interface


inpay_retail_get($res, 30 );


inpay_retail_set($res, 30, $value );

Default Value

''

Remarks

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

Data Type

String

MerchantPassword Property (InPay_Retail Class)

Merchant's Gateway password.

Object Oriented Interface


public function getMerchantPassword();


public function setMerchantPassword($value);

Procedural Interface


inpay_retail_get($res, 31 );


inpay_retail_set($res, 31, $value );

Default Value

''

Remarks

This is the password supplied by the Gateway you signed up with to process credit card transactions. Some gateways require passwords only for Credit or Void transactions, some require it for all transactions, and some do not require this field at all.

Data Type

String

ProxyAuthScheme Property (InPay_Retail 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_retail_get($res, 32 );


inpay_retail_set($res, 32, $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_Retail 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_retail_get($res, 33 );


inpay_retail_set($res, 33, $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_Retail 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_retail_get($res, 34 );


inpay_retail_set($res, 34, $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_Retail 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_retail_get($res, 35 );


inpay_retail_set($res, 35, $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_Retail 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_retail_get($res, 36 );


inpay_retail_set($res, 36, $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_Retail 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_retail_get($res, 37 );


inpay_retail_set($res, 37, $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_Retail 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_retail_get($res, 38 );


inpay_retail_set($res, 38, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ResponseApprovalCode Property (InPay_Retail Class)

Contains an authorization code when a transaction has been approved.

Object Oriented Interface


public function getResponseApprovalCode();


Procedural Interface


inpay_retail_get($res, 39 );


Default Value

''

Remarks

Contains an authorization code when a transaction has been approved. This property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction is not approved, then the contents of this property should be ignored.

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

Data Type

String

ResponseApproved Property (InPay_Retail Class)

Indicates the status of the last transaction.

Object Oriented Interface


public function getResponseApproved();


Procedural Interface


inpay_retail_get($res, 40 );


Default Value

false

Remarks

Indicates the status of the last transaction. This property will be True if the last transaction was approved. However, you should not rely solely on the value contained in this property. After every transaction, the ResponseCode should be inspected and evaluated according to the specifications of the Gateway in use. A list of response codes for each gateway is listed in the table of contents. However, it is recommended that the developer acquire the current list from the Gateway which is being used.

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

Data Type

Boolean

ResponseApprovedAmount Property (InPay_Retail Class)

The amount approved for the transaction, this is the amount actually charged to the credit card.

Object Oriented Interface


public function getResponseApprovedAmount();


Procedural Interface


inpay_retail_get($res, 41 );


Default Value

''

Remarks

The amount approved for the transaction, this is the amount actually charged to the credit card.

This property is primarily used when gateways allow partial authorizations and AllowPartialAuths is 'True'. Thus this property is not used by all gateways and should not alone be used to determine if a transaction was successful (such as in the case that this property is not populated).

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

Data Type

String

ResponseAVSResult Property (InPay_Retail Class)

Contains the Address Verification System result code.

Object Oriented Interface


public function getResponseAVSResult();


Procedural Interface


inpay_retail_get($res, 42 );


Default Value

''

Remarks

Contains the Address Verification System result code. This one character property contains the Address Verification Service (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored for later retrieval, as it may be required when voiding or refunding a transaction. Valid AVS response codes are listed below, and are identical across all Gateway (note that some gateways do not return an AVS response).

ResponseAVSResultDescription
AAddress matches, Zip does not.
EAVS error.
GNon-U.S. issuing bank does not support AVS.
NNo match on Address or CustomerZip.
PAVS not applicable for this transaction.
RRetry - Issuer system unavailable.
SService not supported by issuer.
UAddress information is unavailable.
WNine digit Zip matches, Address does not.
XExact AVS match, nine digit Zip.
YExact AVS match, five digit Zip.
ZFive digit Zip matches, Address does not.

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

Adyen

For Adyen, this property will contain the following possible values:

0Unknown
1Address matches, postal code doesn't
2Neither postal code nor address match
3AVS unavailable
4AVS not supported for this card type
5No AVS data provided
6Postal code matches, address doesn't match
7Both postal code and address match
8Address not checked, postal code unknown
9Address matches, postal code unknown
10Address doesn't match, postal code unknown
11Postal code not checked, address unknown
12Address matches, postal code not checked
13Address doesn't match, postal code not checked
14Postal code matches, address unknown
15Postal code matches, address not checked
16Postal code doesn't match, address unknown
17Postal code doesn't match, address not checked
18Neither postal code nor address were checked

American Payment Solutions

For American Payment Solutions, this property will contain the following possible values:

XExact match, 9-character numeric ZIP
Y, D, or MExact match, 5-character numeric ZIP
2 or 6Exact match, 5-character numeric ZIP, customer name
A or BAddress match only
3 or 7Address, customer name match only
W9-character numeric ZIP match only
Z, P, or L5-character ZIP match only
1 or 55-character ZIP, customer name match only
N or CNo address or ZIP match only
4 or 8No address or ZIP or customer name match only
UAddress unavailable
G or INon-U.S. issuer does not participate
RIssuer system unavailable
ENot a mail/phone order
SService not supported
0, O, or BAVS not available

Barclay

For Barclay, the property will contain the following possible values:

YYAddress and zip code or postal code match
YNAddress matches only
NYZip code or postal code matches
NNNeither address nor zip code or postal code matches; address is not parsable
UUAddress information is unavailable, service is unavailable, or Error; Unknown
BlankNo AVS performed

BlueSnap

For BlueSnap, the property will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following properties:

1st CharacterName AVS check
2nd CharacterAddress AVS check
3rd CharacterPostal/Zip Code AVS check

The possible values for each result character are:

MMatches
NDoes not match
UCould not be verified

HSBC

For HSBC, the property will contain the following possible values:

YYAddress and zip code or postal code match
YNAddress matches only
NYZip code or postal code matches
NNNeither address nor zip code or postal code matches; address is not parsable
UUAddress information is unavailable, service is unavailable, or Error; Unknown
FFIssuer does not participate in AVS
BlankNo AVS performed

PayTrace / PayTraceJSON

For PayTrace / PayTraceJSON, the property will contain the following possible values:

Full Exact Match
Address Match Only
Zip Match Only
No Match
Address Unavailable
Non-US Issuer does not participate
Issuer System Unavailable
Not a Mail/Phone Order
Service Not Supported

QBMS

For the QBMS gateway, the ResponseAVSResult property will contain the result for the street address, a comma, and then the result for the zip code. The values returned are "Pass", "Fail", and "NotAvailable". Therefore, an ResponseAVSResult of "Fail,Pass" means that the street address failed validation, but the zip code passed.

DataCash

For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):

NO DATA MATCHES
ADDRESS MATCH ONLY
SECURITY CODE MATCH ONLY
ALL MATCH
DATA NOT CHECKED

Stripe

For Stripe, the property will contain the following possible values:

Pass The first address line or zip code provided is correct.
Fail The first address line or zip code provided is incorrect.
Unavailable The customer's bank did not check the first address line or zip code provided.
Unchecked The first address line or zip code was provided but has not yet been checked.

Worldpay

For Worldpay, the property will contain a 4-character string, which contains the AVS checks for the following properties:

1st CharacterCard Verification Value (CVV) check
2nd CharacterPostal/Zip Code AVS check
3rd CharacterAddress AVS check
4th CharacterCountry Comparison check

The possible values for each result character are:

0Not Supported.
1Not Checked.
2Matched.
4No Match.
8Partial Match.

Worldpay Online

For Worldpay Online, the property will contain one of the following:

ValueDescription
APPROVED The supplied street and postal code details fully matched the payment provider's records
PARTIAL APPROVED One of the supplied street or postal code details did not match the payment provider's records
NOT SENT TO ACQUIRER Problem with acquirer - possibly no AVS support
NO RESPONSE FROM ACQUIRERProblem with acquirer - possibly no AVS support
NOT CHECKED BY ACQUIRER The acquirer did not check the address details
NOT SUPPLIED BY SHOPPER Missing, incomplete or invalid address details in the order prevented the address from being checked
FAILED Both street and postal code details did not match the payment provider's records

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

Data Type

String

ResponseCode Property (InPay_Retail Class)

Indicates the status of the authorization request.

Object Oriented Interface


public function getResponseCode();


Procedural Interface


inpay_retail_get($res, 43 );


Default Value

''

Remarks

Indicates the status of the authorization request. This property contains the actual response code as returned by the Gateway. Unlike the ResponseApproved property, this ResponseCode property may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the ResponseCode as well as the ResponseApproved property. The Point of Sale system should evaluate this response code and NOT the ResponseText to determine nature of a response message. The current (at the time of this release) response codes for the supported Gateways are listed in the table of contents to your left.

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

Data Type

String

ResponseCVVResult Property (InPay_Retail Class)

Contains the returned CVV2 result code if it was requested.

Object Oriented Interface


public function getResponseCVVResult();


Procedural Interface


inpay_retail_get($res, 44 );


Default Value

''

Remarks

Contains the returned CVV2 result code if it was requested. This property contains the host returned CVV2 result code (if CVV data was sent in the request). The following is a list of current result codes:

MCVV2 Match.
NCVV2 No Match.
PNot Processed.
SMerchant has indicated that CVV2 is not present on card.
UIssuer not certified and/or has not provided Visa encryption keys.

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

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

HSBC

For HSBC, the property will contain:

0Card type does not support CVM
1CVM match
2CVM did not match issuer value
3CVM was not processed
4CVM should be on the card but cardholder indicated otherwise
5CVM not supported by issuer
6Not valid
7No response from server

Adyen

For Adyen, the property will contain:

0Unknown
1Matches
2Does not match
3Not checked
4No CVC/CVV provided, but was required
5Issuer not certified for CVC/CVV
6No CVC/CVV provided

Barclay

For Barclay, the property will contain:

0,1CVM was not processed
2CVM match
4CVM does not match issuer value
UnknownCVM invalid or missing
BlankNo response from server

BlueSnap

For BlueSnap, the property will contain:

MAMatch
NCIssuer is not certified for CVV2/CVC2/CID
NDCheck was not done
NMNo match
NPCVV2/CVC2/CID should be on the card but is not present
NRCVV check not requested

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

DataCash

For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):

NO DATA MATCHES
ADDRESS MATCH ONLY
SECURITY CODE MATCH ONLY
ALL MATCH
DATA NOT CHECKED

Stripe

For Stripe, the property will contain the following possible values:

Pass The CVC provided is correct.
Fail The CVC provided is incorrect.
Unavailable The customer's bank did not check the CVC provided.
Unchecked The CVC was provided but has not yet been checked.

Worldpay Online

For Worldpay Online, the property will contain one of the following:

ValueDescription
APPROVED The supplied CVC details matched the payment provider's records
NOT SENT TO ACQUIRER Problem with acquirer - possibly no CVC support
NO RESPONSE FROM ACQUIRERProblem with acquirer - possibly no CVC support
NOT CHECKED BY ACQUIRER The acquirer did not check the CVC details
NOT SUPPLIED BY SHOPPER Missing, or invalid CVC in the payment details prevented the CVC from being checked
FAILED The supplied CVC did not match the payment provider's records

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

Data Type

String

ResponseData Property (InPay_Retail Class)

The entire response returned from the gateway processor.

Object Oriented Interface


public function getResponseData();


Procedural Interface


inpay_retail_get($res, 45 );


Default Value

''

Remarks

The entire response returned from the gateway processor. This property contains the entire response returned from the gateway processor. You may use this to parse additional information that is not returned in the standard response properties.

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

Data Type

String

ResponseErrorCode Property (InPay_Retail Class)

Additional error code returned by some gateways.

Object Oriented Interface


public function getResponseErrorCode();


Procedural Interface


inpay_retail_get($res, 46 );


Default Value

''

Remarks

Additional error code returned by some gateways. If a gateway returns it, this property will contain an additional code that may explain why the transaction was declined. You may also wish to inspect ResponseErrorText for a human-readable description of this ResponseErrorCode.

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

Data Type

String

ResponseErrorText Property (InPay_Retail Class)

Additional error description returned by some gateways.

Object Oriented Interface


public function getResponseErrorText();


Procedural Interface


inpay_retail_get($res, 47 );


Default Value

''

Remarks

Additional error description returned by some gateways. If a gateway returns it, this property will contain a human-readable description of the error which occurred (if any). You may also wish to inspect ResponseErrorCode for an accompanying code which may be parsed and used by your application.

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

Data Type

String

ResponseInvoiceNumber Property (InPay_Retail Class)

Invoice number submitted in authorization request (if applicable).

Object Oriented Interface


public function getResponseInvoiceNumber();


Procedural Interface


inpay_retail_get($res, 48 );


Default Value

''

Remarks

Invoice number submitted in authorization request (if applicable). This property contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.

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

Data Type

String

ResponseProcessorCode Property (InPay_Retail Class)

Response code from the underlying processor.

Object Oriented Interface


public function getResponseProcessorCode();


Procedural Interface


inpay_retail_get($res, 49 );


Default Value

''

Remarks

Response code from the underlying processor. Often times a Gateway will return a ResponseCode that indicates only whether the transaction is approved or declined. Many of these also include a secondary code that provides more details as to why the transaction was declined.

Note, for the PayFlowPro Gateway this property will contain a "1" if the transaction was a duplicate, a "-1" if duplicate checking service is unavailable, and will be blank for a successfully authorized transaction.

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

Data Type

String

ResponseText Property (InPay_Retail Class)

Text information that describes each response code.

Object Oriented Interface


public function getResponseText();


Procedural Interface


inpay_retail_get($res, 50 );


Default Value

''

Remarks

Text information that describes each response code. This property contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. A Gateway may translate the response according to the language indicated in the merchant account setup (if applicable).

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

Data Type

String

ResponseTransactionId Property (InPay_Retail Class)

Contains the Visa Transaction Identifier or MasterCard Reference Number.

Object Oriented Interface


public function getResponseTransactionId();


Procedural Interface


inpay_retail_get($res, 51 );


Default Value

''

Remarks

Contains the Visa Transaction Identifier or MasterCard Reference Number. This property contains a transaction identifier or reference number. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and used to submit a modification of this transaction at a later time (such as voiding the transaction or capturing an authorization-only transaction, if applicable).

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

Data Type

String

ShippingAddress Property (InPay_Retail Class)

Customer's shipping street address.

Object Oriented Interface


public function getShippingAddress();


public function setShippingAddress($value);

Procedural Interface


inpay_retail_get($res, 52 );


inpay_retail_set($res, 52, $value );

Default Value

''

Remarks

Customer's shipping street address.

This property is not available at design time.

Data Type

String

ShippingAddress2 Property (InPay_Retail Class)

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

Object Oriented Interface


public function getShippingAddress2();


public function setShippingAddress2($value);

Procedural Interface


inpay_retail_get($res, 53 );


inpay_retail_set($res, 53, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

ShippingCity Property (InPay_Retail Class)

Customer's shipping city.

Object Oriented Interface


public function getShippingCity();


public function setShippingCity($value);

Procedural Interface


inpay_retail_get($res, 54 );


inpay_retail_set($res, 54, $value );

Default Value

''

Remarks

Customer's shipping city.

This property is not available at design time.

Data Type

String

ShippingCountry Property (InPay_Retail Class)

Customer's shipping country.

Object Oriented Interface


public function getShippingCountry();


public function setShippingCountry($value);

Procedural Interface


inpay_retail_get($res, 55 );


inpay_retail_set($res, 55, $value );

Default Value

''

Remarks

Customer's shipping country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.

This property is not available at design time.

Data Type

String

ShippingEmail Property (InPay_Retail Class)

Customer's email address.

Object Oriented Interface


public function getShippingEmail();


public function setShippingEmail($value);

Procedural Interface


inpay_retail_get($res, 56 );


inpay_retail_set($res, 56, $value );

Default Value

''

Remarks

Customer's email address.

This property is not available at design time.

Data Type

String

ShippingFirstName Property (InPay_Retail Class)

Customer's first name.

Object Oriented Interface


public function getShippingFirstName();


public function setShippingFirstName($value);

Procedural Interface


inpay_retail_get($res, 57 );


inpay_retail_set($res, 57, $value );

Default Value

''

Remarks

Customer's first name.

This property is not available at design time.

Data Type

String

ShippingLastName Property (InPay_Retail Class)

Customer's last name.

Object Oriented Interface


public function getShippingLastName();


public function setShippingLastName($value);

Procedural Interface


inpay_retail_get($res, 58 );


inpay_retail_set($res, 58, $value );

Default Value

''

Remarks

Customer's last name.

This property is not available at design time.

Data Type

String

ShippingPhone Property (InPay_Retail Class)

Customer's phone number.

Object Oriented Interface


public function getShippingPhone();


public function setShippingPhone($value);

Procedural Interface


inpay_retail_get($res, 59 );


inpay_retail_set($res, 59, $value );

Default Value

''

Remarks

Customer's phone number.

This property is not available at design time.

Data Type

String

ShippingState Property (InPay_Retail Class)

Customer's shipping state.

Object Oriented Interface


public function getShippingState();


public function setShippingState($value);

Procedural Interface


inpay_retail_get($res, 60 );


inpay_retail_set($res, 60, $value );

Default Value

''

Remarks

Customer's shipping state.

This property is not available at design time.

Data Type

String

ShippingZip Property (InPay_Retail Class)

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

Object Oriented Interface


public function getShippingZip();


public function setShippingZip($value);

Procedural Interface


inpay_retail_get($res, 61 );


inpay_retail_set($res, 61, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

SpecialFieldCount Property (InPay_Retail Class)

The number of records in the SpecialField arrays.

Object Oriented Interface


public function getSpecialFieldCount();


public function setSpecialFieldCount($value);

Procedural Interface


inpay_retail_get($res, 62 );


inpay_retail_set($res, 62, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

SpecialFieldName Property (InPay_Retail Class)

Name of special configuration property to submit in this transaction.

Object Oriented Interface


public function getSpecialFieldName($fieldindex);


public function setSpecialFieldName($fieldindex, $value);

Procedural Interface


inpay_retail_get($res, 63 , $fieldindex);


inpay_retail_set($res, 63, $value , $fieldindex);

Default Value

''

Remarks

Name of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.

This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

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

This property is not available at design time.

Data Type

String

SpecialFieldValue Property (InPay_Retail Class)

Value of special configuration property to submit in this transaction.

Object Oriented Interface


public function getSpecialFieldValue($fieldindex);


public function setSpecialFieldValue($fieldindex, $value);

Procedural Interface


inpay_retail_get($res, 64 , $fieldindex);


inpay_retail_set($res, 64, $value , $fieldindex);

Default Value

''

Remarks

Value of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.

Note: This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

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

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (InPay_Retail Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface


inpay_retail_get($res, 66 );


inpay_retail_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_Retail Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface


inpay_retail_get($res, 94 );


inpay_retail_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_Retail 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_retail_get($res, 110 );


inpay_retail_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_Retail 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_retail_get($res, 111 );


inpay_retail_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_Retail Class)

This is the type of certificate store for this certificate.

Object Oriented Interface


public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface


inpay_retail_get($res, 112 );


inpay_retail_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_Retail 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_retail_get($res, 113 );


inpay_retail_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_Retail Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface


public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface


inpay_retail_get($res, 121 );


inpay_retail_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_Retail Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface


public function getSSLServerCertEncoded();


Procedural Interface


inpay_retail_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

TestMode Property (InPay_Retail Class)

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

Object Oriented Interface


public function getTestMode();


public function setTestMode($value);

Procedural Interface


inpay_retail_get($res, 150 );


inpay_retail_set($res, 150, $value );

Default Value

false

Remarks

You can use this property to set a test mode flag that will be sent in an authorization request. Not all Gateways support test modes. If you set the TestMode property to True and the current Gateway does not support it, the class will fails with an error.

Data Type

Boolean

Timeout Property (InPay_Retail Class)

A timeout for the class.

Object Oriented Interface


public function getTimeout();


public function setTimeout($value);

Procedural Interface


inpay_retail_get($res, 151 );


inpay_retail_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

TransactionAmount Property (InPay_Retail Class)

Purchase amount for an authorization transaction.

Object Oriented Interface


public function getTransactionAmount();


public function setTransactionAmount($value);

Procedural Interface


inpay_retail_get($res, 152 );


inpay_retail_set($res, 152, $value );

Default Value

''

Remarks

This field contains the transaction amount to be authorized. Gateways may have differing requirements for how the TransactionAmount should be formatted, so refer to the ICharge Gateway Setup page for details on the gateway you are using.

Data Type

String

TransactionDesc Property (InPay_Retail Class)

Description of goods purchased.

Object Oriented Interface


public function getTransactionDesc();


public function setTransactionDesc($value);

Procedural Interface


inpay_retail_get($res, 153 );


inpay_retail_set($res, 153, $value );

Default Value

''

Remarks

This field contains a description of the goods or services being purchased. Please see the "ICharge Gateway Setup and Required Properties" page to determine if this is a required or optional field for the gateway you are using.

Data Type

String

TransactionId Property (InPay_Retail Class)

Merchant-generated transaction Id used for all transactions.

Object Oriented Interface


public function getTransactionId();


public function setTransactionId($value);

Procedural Interface


inpay_retail_get($res, 154 );


inpay_retail_set($res, 154, $value );

Default Value

''

Remarks

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

Data Type

String

AddSpecialField Method (InPay_Retail Class)

Adds a special field name and the corresponding value.

Object Oriented Interface

public function doAddSpecialField($name, $value);

Procedural Interface

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

Remarks

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

AuthOnly Method (InPay_Retail Class)

Initiates an authorization-only request transaction.

Object Oriented Interface

public function doAuthOnly();

Procedural Interface

inpay_retail_do_authonly($res);

Remarks

This method sends an authorization-only request to the specified Gateway. This transaction is not added to the current open batch, and must be completed later with the Capture method (you may use the Sale method if you wish to authorize and capture in one step).

Note: If the Gateway does not support this method, the class will fails with an error.

AVSOnly Method (InPay_Retail Class)

Used to check the validity of the card without authorizing funds.

Object Oriented Interface

public function doAVSOnly();

Procedural Interface

inpay_retail_do_avsonly($res);

Remarks

This method can be used if you wish to perform fraud (AVS and CVV) checks on a card, but don't actually wish to charge the customer. This is useful for pre-ordering an item that has not yet been released or is currently back- ordered. The card information is validated by the merchant, and when the item is later in stock and ships to the customer, an Sale transaction can be performed.

Note: If the Gateway does not support this method, the class will fails with an error.

Capture Method (InPay_Retail Class)

Captures a previously authorized transaction.

Object Oriented Interface

public function doCapture($transactionid, $captureamount);

Procedural Interface

inpay_retail_do_capture($res, $transactionid, $captureamount);

Remarks

This method captures a transaction that has been previously authorized with the AuthOnly method. The TransactionId parameter indicates to the Gateway which transaction is to be captured, and should contain the ResponseTransactionId from the original transaction. The CaptureAmount parameter is the value to be captured from the customer's credit card, and can be different from the authorized amount.

Please see the gateway information in the table of contents to determine if your gateway supports Capture transactions.

The LinkPoint and PSIGateXML gateways require you send the ResponseInvoiceNumber rather than the ResponseTransactionId.

The SecurePay gateway does not require the TransactionId for captures. Instead, you must send the ResponseApprovalCode returned from the original response in the AuthCode property.

The MyVirtualMerchant and Converge gateways do not require the TransactionId for captures. Instead, you must send the ResponseApprovalCode returned from the original response in the AuthCode property. Note that there is a new capture transaction type available for these gateways. To use the new transaction type, set the MyVirtualMerchantTransactionType to "CCCOMPLETE" and call Capture like normal. When using this transaction type, TransactionId is required and ResponseApprovalCode is not applicable.

Config Method (InPay_Retail Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Credit Method (InPay_Retail Class)

Credits a customer's card.

Object Oriented Interface

public function doCredit();

Procedural Interface

inpay_retail_do_credit($res);

Remarks

This method credits a customer's card specified via Card. This type of transaction is NOT based on previous transaction. Some gateways refer to these as "Open" or "Blind" Credits.

TransactionAmount is used to specify the amount you wish to return to the customer's card.

Please see the gateway information in the table of contents to determine if your gateway supports Credit transactions.

DoEvents Method (InPay_Retail Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

Force Method (InPay_Retail Class)

Used when authorization cannot be obtained online.

Object Oriented Interface

public function doForce($voiceauthcode);

Procedural Interface

inpay_retail_do_force($res, $voiceauthcode);

Remarks

This method is used when the response to a Sale or AuthOnly request indicates that voice authorization is required. The merchant then telephones the call center and receives a voice authorization code. Calling the Force method with this code in the VoiceAuthCode parameter will complete the transaction.

Note: If the Gateway does not support this method, the class will fails with an error.

GetResponseVar Method (InPay_Retail Class)

Parses additional information out of the response.

Object Oriented Interface

public function doGetResponseVar($name);

Procedural Interface

inpay_retail_do_getresponsevar($res, $name);

Remarks

Due to the fact that this class supports so many gateways, only the most commonly used response variables are parsed into the Response properties. Any additional response information contained within the ResponseData may be retrieved with this GetResponseVar method. There are three formats for the ResponseData returned by the gateways this class supports: Name/value pairs, delimited list, or XML. The value you pass in the Name parameter changes based on these formats, as detailed below:

If the ResponseData property contains name/value pairs, pass the name in the Name parameter and this method will return the value. For instance, if ResponseData contains "ResponseCode=00&FraudScore=53&ApprovalCode=123456&...", calling GetResponseVar("FraudScore") will return "53".

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

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

Interrupt Method (InPay_Retail Class)

Interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

inpay_retail_do_interrupt($res);

Remarks

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

Refund Method (InPay_Retail Class)

Refunds a previously captured transaction.

Object Oriented Interface

public function doRefund($transactionid, $refundamount);

Procedural Interface

inpay_retail_do_refund($res, $transactionid, $refundamount);

Remarks

This method refunds a transaction that has already been captured, or settled. If the transaction is still outstanding use the VoidTransaction method instead. The TransactionId parameter indicates to the Gateway which transaction is to be refunded, and should contain the ResponseTransactionId from the original transaction. The RefundAmount parameter is the value to be refunded back to the customer, and can be all or part of the original TransactionAmount

Please see the gateway information in the table of contents to determine if your gateway supports Refund transactions.

The gw3DSI gateway requires the following additional fields for Refund transactions:

class.AddSpecialField "UserId", "my 3DSI-assigned UserId" '(Different than MerchantLogin) class.MerchantPassword = "my 3DSI-assigned Pwd"

The LinkPoint and PSIGateXML gateways require you send the ResponseInvoiceNumber rather than the ResponseTransactionId.

Reset Method (InPay_Retail Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

inpay_retail_do_reset($res);

Remarks

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

ResetSpecialFields Method (InPay_Retail Class)

Resets all special fields to the default settings.

Object Oriented Interface

public function doResetSpecialFields();

Procedural Interface

inpay_retail_do_resetspecialfields($res);

Remarks

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

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

Sale Method (InPay_Retail Class)

Initiates an Sale transaction (authorization and capture).

Object Oriented Interface

public function doSale();

Procedural Interface

inpay_retail_do_sale($res);

Remarks

Sends a basic sale transaction to the Gateway. This transaction decrements the cardholder's open-to-buy funds for the TransactionAmount, and the transaction is automatically added to the current open batch.

VoidTransaction Method (InPay_Retail Class)

Voids a previously authorized transaction.

Object Oriented Interface

public function doVoidTransaction($transactionid);

Procedural Interface

inpay_retail_do_voidtransaction($res, $transactionid);

Remarks

This method voids a transaction that has been previously authorized, but which has not yet gone to settlement, or been "captured". The TransactionId parameter indicates to the Gateway which transaction is to be voided, and should contain the ResponseTransactionId from the original transaction.

Please see the gateway information in the table of contents to determine if your gateway supports Void transactions.

To cancel a transaction which has already been captured, use the Credit method.

The LinkPoint gateway requires you send the ResponseInvoiceNumber rather than the ResponseTransactionId.

For the PSIGateXML gateway, send the ResponseTransactionId as normal.

For the Heartland gateway, a reversal transaction will be sent when a TransactionAmount is specified. Otherwise a void transaction will be sent.

Error Event (InPay_Retail Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inpay_retail_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_Retail Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

inpay_retail_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_Retail Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

inpay_retail_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 (Retail 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.

Retail Config Settings

3DSAuthenticationStatus:   Indicates whether a transaction qualifies as a ThreeDSecure (3DS) authenticated transaction.

This setting is used to pass the 3D Secure authentication status on to the transaction server. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. Other values necessary for passing 3D Secure data include 3DSCAVV, 3DSXID and 3DSECI. This setting is only valid for E-Commerce transactions. Applicable values are:

YThe customer was successfully authenticated.
NThe customer failed authentication, and the transaction is denied.
UAuthentication could not be performed due to technical or other problems.
AAuthentication was not available, but functionality was available (through the issuer, Visa, or a third party) to generate a proof of authentication attempt.

3DSCAVV:   Cardholder Authentication Verification Value from a 3D Secure authentication.

This setting is used to pass 3D Secure CAVV data on to the transaction server. This field must be formatted as a 28-byte Base-64 encoded value. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. Other values necessary for passing 3D Secure data include 3DSXID and 3DSECI. This setting is only valid for E-Commerce transactions.

3DSDSTransactionId:   Directory server transaction Id from a 3D Secure authentication.

This setting is used to pass the directory server transaction Id to the gateway for 3DS 2.0. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. This setting is only valid for E-Commerce transactions. This setting is currently only supported when the Gateway property is set to gwNetbanx.

3DSECI:   Electronic Commerce Indicator.

This contains a 1-character transaction indicator identifying the type of transaction being authorized. Supported values vary between gateways, so please consult gateway documentation for more information. Note: Other values necessary for passing 3D Secure data are 3DSXID and 3DSCAVV. This setting is only valid for E-Commerce transactions.

3DSEnrollmentStatus:   Indicates whether 3D Secure authentication is available for the cardholder.

This setting is used to pass the cardholder's 3D Secure enrollment status to the gateway for 3D Secure 1.0.2. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. This setting is only valid for E-Commerce transactions. This setting is currently only supported when the Gateway property is set to gwNetbanx.

3DSXID:   TransactionId from a 3D Secure authentication.

This setting is used to pass the 3D Secure TransactionId (XID) data on to the gateway. This setting must be formatted as a 20-byte plaintext value, or a 28-byte Base-64 encoded value. This component may be used in conjunction with the ThreeDSecure component or with any other 3D Secure MPI implementation. For example: Other settings necessary for passing 3D Secure data are 3DSCAVV and 3DSECI. This setting is only valid for E-Commerce transactions.

AllowPartialAuths:   Specifies whether partial authorizations are allowed.

When set to 'True', partial authorizations will be allowed and must be handled accordingly. A partial authorization occurs when a customer's available funds for a specific card can only meet a portion of the total TransactionAmount. Therefore a second means of payment must be used to pay for the remaining amount. When such a case occurs, the partially approved amount will be made available via ResponseApprovedAmount. When set to 'False', if a customer's card does not have funds the available to account for the entire TransactionAmount the transaction will be declined. The default value is 'True'.

AmountFormat:   Used to set the input format for TransactionAmount.

This configuration setting can be used to specify a single input format for the TransactionAmount property. When set to a value other than 0, the class will automatically convert the amount from the specified format to the format expected by the gateway. Valid values are:

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

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

ApplePayData:   The Base-64 encoded data containing the encrypted payment data from Apple for use when performing Apple Pay transactions.

This setting specifies the Base-64 encoded data containing the encrypted payment data received from Apple. The encrypted payment data must be retrieved in a separate process by communicating with the Apple Passbook app. Once the encrypted payment data is received from Apple set this configuration setting, which takes the place of Card, and perform either an AuthOnly or Sale transaction to process the payment.

This setting is applicable to the following gateways:

  • Authorize.NET (gwAuthorizeNet)
  • BlueSnap (gwBlueSnap)

AuthNetShipToCompany:   The name of the company associated with the customer's shipping address.

This configuration setting can be used to set the company associated with the shipping address of the customer.

AuthNetSplitTenderId:   Authorize.Net assigned id for partially authorized transactions.

When AllowPartialAuths configuration setting is set to true and there are not enough funds to cover the full transaction amount set using the TransactionAmount property, Authorize.NET will return a Split Tender Id that can be later used, to link to the original partially authorized transaction, to charge the full amount, void, or capture.

BluePayKSN:   The Key Serial Number (KSN) used to encrypt the card magnetic stripe data for the BluePay gateway.

This config is used to specify the Key Serial Number (KSN) value after encrypting card magnetic stripe (track) data and is returned using BluePay's encryption tools. Prior to specifying encrypted card data, CardEncrypted should be set to "True".

BluePayMasterId:   Used to reference a previous transaction in BluePay.

This setting takes a previous transaction's ResponseTransactionId. For any parameters that are not set, BluePay will use values from the referenced transaction.

BluePayPreEncryptedTrackLength:   The length of the magnetic stripe data prior to encryption for the BluePay gateway.

This config is used to specify the length of the magnetic stripe (track) data prior to it being encrypted using BluePay's encryption tools. Prior to specifying encrypted card data, CardEncrypted should be set to "True".

BluePayUpdate:   Used to perform an Update transaction for BluePay.

When set to true, the component will update a prevous transaction when the Sale method is called. BluePayMasterId must be set to the ResponseTransactionId of the previous request, and the transaction can only be updated before it has been settled by BluePay.

CardEncrypted:   Specifies whether the card magnetic stripe data is encrypted.

Set this config to "True" to allow encrypted card track data to be specified and sent in the request. Note that this config must be set to "True" prior to setting CardMagneticStripe to the encrypted magnetic stripe data, otherwise an exception may be thrown when the component attempts to verify the magnetic stripe data format. The default value is "False".

Note: When using the BASYS, PhoeniXGate, or Repay Gateways, set this configuration setting to True so both Track1 and Track2 Data are sent in the request.

CardholderPresentCode:   Specifies the way in which transaction took place.

This config allows you to specify the way in which the transaction took place. This config is applicable to the Barclay, HSBC, and PayFuse gateways.

Applicable values are:

Value Description
1 Cardholder present (Default value sent by the Retail component when MagneticStripe data specified)
2 Cardholder present, signature obtained
3 Cardholder not present, unspecified/unknown
4 Cardholder not present, mail/fax order
5 Cardholder not present, telephone
6 Cardholder not present, standing authorization (installment)
7 Cardholder not present, electronic transaction (Default value sent by the ICharge component)
8 Cardholder not present, recurring billing
9 Address used for Id
10 Card not present (installment)
11 Card not present (SET, with Merchant and cardholder certificate)
12 Card not present (SET with Merchant certificate only)
13 Card not present, but payer authentication was used
14 Cardholder present, but card information manually keyed (Default value sent by the Retail component when card is manually entered)

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

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

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

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

This config is currently applicable to the Heartland gateway.

CardStartMonth:   Used for some international cards.

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

CardStartYear:   Used for some international cards.

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

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

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

The available card types are:

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

CAVVResponse:   Contains CAVV response value returned by the gateway.

This property will contain the CAVV response value to the authorization and will be populated along with Response. Values vary between gateways, so please consult gateway documentation for more information.

COFPermission:   Indicates if the customer gave permission to make a Card On File transaction.

When true, this setting indicates that the customer gave the merchant permission to perform a Card On File (COF) transaction. Currently only used by CardPointe (gwCardPointe).

ConvenienceFee:   The total convenience fee charged for a transaction.

This field is used to specify the total convenience fee charged for the transaction. This field is applicable to the FirstDataPayPoint and Litle / Vantiv gateway.

CurrencyCode:   Currency code for the currency of the transaction.

This config is used to specify the currency code to be used in the transaction. Default values and codes vary based on the gateway. This config will be populated with the default value for the gateway when Gateway is set.

For more information on these currency code values, please refer to the ISO 4217 standard as well as the gateway specification.

CurrencyExponent:   Currency exponent to be used in conjunction with the Currency code of the transaction.

If not set, "2" is sent by default. Currently only supported in the Orbital and WorldPayXML gateways.

CyberSourceAuthToken:   The request token from a previous authorization for the CyberSource gateway.

This config is used to specify a request token for authorization update transactions (such as captures, credits, voids, and reversals). This is only applicable when using the Atos interface.

CyberSourceProfileId:   The Id of a Customer's Profile stored within the CyberSource gateway.

This config allows you to specify a customer Profile Id to process a transaction using the customer's information stored within CyberSource's systems (this is known as Payment Tokenization). When specified, the ProfileId will be sent instead of the card data (when performing an AuthOnly or Sale) and thus the stored card in the customer's profile will be charged. Additionally you can Credit a card on a customer's profile by specifying a Profile Id and a TransactionId of "" (empty string). Please note that the component does NOT support creating, modifying, or deleting customer profiles. These will need to be created using the RecurringBilling component or by other means such as within CyberSource's Business Center.

CyberSourceVoidMode:   Indicates whether to perform a Void or Reversal.

If CyberSourceVoidMode is set to "Void" (default), VoidTransaction sends a void transaction to cancel a Capture or Credit request. Note a transaction can only be voided if CyberSource has not already submitted the capture or credit request to the processor (this is usually done once a day). If CyberSourceVoidMode is set to "Reverse", a full authorization reversal transaction is sent to reverse a previous authorization (i.e. after performing an AuthOnly transaction). Note in a reversal, it is required that TransactionAmount be set to the full amount authorized (as you cannot partially reverse an authorization).

CyberSourceXMLEscape:   Determines whether to XML escape the CyberSource gateway request field values.

If this setting is set to "True", the request field values will be XML escaped prior to being sent to the CyberSource gateway. If this setting is set to "False" (default), the class does not perform any XML escaping and the values are sent exactly as specified. The default value is "False".

DebitKSN:   Clear-text Key Sequence Number retrieved from a PIN pad.

This field is used to set a 19 or 20-byte Key Sequence Number (KSN). This field is associated with DebitPIN and both are required for Debit Sale transactions.

The following gateways support Debit card transactions:

  • gwEprocessing(2)
  • gwMerchantPartners(31)
  • gwJetPay(65)
  • gwBluePay(67)
  • gwWorldPayLink(87)
  • gwFirstDataPayPoint(90)
  • gwPhoeniXGate(97)
  • gwRepay(98)
  • gwBASYS(106)

DebitPIN:   DUKPT DES encrypted pin block, retrieved from a PIN pad.

This field is used to set a 16-byte encrypted PIN for a Debit card. This field is associated with DebitKSN and both are required for Debit Sale transactions.

The following gateways support Debit card transactions:

  • gwEprocessing(2)
  • gwMerchantPartners(31)
  • gwJetPay(65)
  • gwBluePay(67)
  • gwWorldPayLink(87)
  • gwFirstDataPayPoint(90)
  • gwPhoeniXGate(97)
  • gwRepay(98)
  • gwBASYS(106)

DynamicDescriptor:   A merchant defined transaction description which appears on the customer's credit card statement.

This field is used to specify a dynamic descriptor (sometimes called a soft descriptor) for the transaction. Typically this value is used to specify transaction specific details which will be displayed on the customer's credit card statement.

The following gateways currently support this functionality: Heartland.

EscapeXML:   Automatically escape data within XML tags.

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

FDMSCurrentBalance:   Contains the current card balance value returned in a response for the First Data E4, Payeezy, and Bank Of America gateways.

When returned in the response, this field will be populated with the current balance on the card used to process the transaction.

FDMSGiftCardTransactionType:   Specifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways.

This field is used to specify the gift card transaction type you wish to perform. All gift card transactions are performed by setting the type via this config and calling the Sale method. When the transaction type is set to '0', the Sale, VoidTransaction and Refund methods can be called to perform their respective transactions. Note to process a gift card transaction, FDMSProcessGiftCard must be set to 'True'.

Applicable values are:

Value Description
0 (Default) Regular transaction (based on method called).
1 ValueLink Activation
2 Balance Inquiry
3 Reload
4 CashOut
5 ValueLink Deactivation

FDMSKeyId:   The Key Id that corresponds to the HMAC Key for the First Data E4, Payeezy, and Bank Of America gateways.

This config is used to specify the Key Id, obtained from FDMS, that corresponds to the HMAC Key (specified via HashSecret) and is sent within the Authorization header of the request.

FDMSProcessGiftCard:   Specifies whether the card being processed is a gift card for the First Data E4, Payeezy, and Bank Of America gateways.

When set to 'True', the current transaction will be run as a gift card transaction. The default value 'False', will perform a regular credit card transaction.

FDMSTransArmorToken:   The Transarmor token that replaces a card number and used for transaction processing.

This config is used to both retrieve and specify a Transarmor Token for the First Data E4, Payeezy, and Bank Of America gateways. If your account is configured for Transarmor tokens, a token will be created by the server and returned via this config when performing a transaction using a Card data. Additionally, you can set this config to a previously retrieved token value and the token will be sent in the request rather than the Card data. This increases security as raw card data is no longer needed. Note when sending an FDMSTransArmorToken value, the CardType, CardExpMonth, and CardExpYear are required.

FDMSWalletProviderId:   Specifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways.

This field is used to specify a wallet provider when using a digital wallet like Apple Pay or Android Pay. By default this field is not sent, and no wallet provider is used.

Applicable values are:

Value Description
1 No wallet provider
2 Visa Checkout
3 MasterPass
4 Apple Pay
5 Samsung Pay
6 Android Pay

GlobalIrisRefundPassword:   The Refund password for the Global Iris gateway.

This config is used to specify the refund password provided to you by Global Iris. When a refund is performed, the component will use the specified password to generate and send a 'refundhash' in the request. This value is required when performing a Refund transaction.

GoEMerchantUseGatewayId:   Indicates whether to send a password or gateway Id for the GoEMerchant gateway.

By default, the Password property is sent as the "password" field in all requests. If the GoEMerchantUseGatewayId configuration setting is set to True, the class will instead treat the password as the "gateway_id" field in all requests.

HashAlgorithm:   Algorithm used for hashing.

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

Value Algorithm
0 MD5 (default)
1 SHA-1

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

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

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

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

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

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

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

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

HeartlandDeveloperId:   Optional DeveloperId field used by the Heartland gateway.

If HeartlandDeveloperId is set, the HeartlandVersionNumber should also be set. If set, this field must be exactly 6 characters in length.

HeartlandDeviceId:   DeviceId field required by the Heartland gateway.

This is issued by Heartland during registration.

HeartlandLicenseId:   LicenseId field required by the Heartland gateway.

This is issued by a Heartland Payment Systems Administrator during registration.

HeartlandReversalAmount:   The settlement amount to be used when performing a reversal for the Heartland gateway.

The Heartland gateway supports reversals of credit card transactions. To perform a reversal, TransactionAmount can be set and the VoidTransaction can be called. When performing a reversal, TransactionAmount must be set to the original authorized amount of the transaction you are performing the reversal on. This field should then be set to the settlement amount of the transaction (or the final authorized amount after the reversal is performed).

HeartlandSecretAPIKey:   Specifies the secret key to be used for authentication with Heartland.

If Heartland provides a secret key for use with their API, this property can be used to send it to the gateway. When this key is set, the HeartlandLicenseId, HeartlandSiteId, HeartlandDeviceId, MerchantLogin and MerchantPassword are not required, and will not be sent to the gateway.

HeartlandShipDay:   Ship day field required by the Heartland gateway e-commerce/direct marketing transactions.

The ship day for the Heartland transaction. Valid values are 1 - 31.

HeartlandShipMonth:   Ship month field required by the Heartland gateway e-commerce/direct marketing transactions.

The ship month for the Heartland transaction. Valid values are 1 - 12.

HeartlandSiteId:   SiteId field required by the Heartland gateway.

This is issued by Heartland during registration.

HeartlandSiteTrace:   Optional transaction identifier for the Heartland gateway.

Heartland supplies an additional way to trace the transaction, beyond the InvoiceNumber and TransactionId.

HeartlandTokenMapping:   The type of token to return when using Tokenization with the Heartland gateway.

The field is used to specify the type of token that should be returned when using the Heartland gateway. By setting this field to a value other than 0 (None), a Token will be requested and returned in the response via HeartlandTokenValue (provided one can be generated). Please see the "ICharge Gateway Setup and Required Properties" page for more details about using tokenization, as there are special merchant account configurations required.

The available mapping values are:

0 None: Tokenization is not requested. This is the default value.
1 Unique: This setting instructs the tokenization system to return a new, unique token value for the specified card number. The returned token value is unique within the merchant's token group.
2 Constant: This setting instructs the tokenization system to return a constant token value for the specified card number. The returned token value is unique within the merchant's token group, but the same token is always returned for a particular card number.

HeartlandTokenValue:   Used to retrieve or specify a Heartland token value.

This field is used to retrieve a Heartland Token value when using Heartland Tokenization (which is accomplished by setting HeartlandTokenMapping to a value greater than 0). A token replaces the card number in all subsequent transactions thus increasing security. This field can also be used to specify a previously retrieved token value. When set, the specified token value will be sent in the request instead of the card number.

HeartlandVersionNumber:   Optional VersionNumber field used by the Heartland gateway.

If HeartlandVersionNumber is set, the HeartlandDeveloperId should also be set. If set, this field must be exactly 4 characters in length.

LitleAdvancedFraudChecksId:   Used to specify the Id for use in the AdvancedFraudChecks element for the Litle gateway.

This field is used to specify the Id for the AdvancedFraudChecks element for the Litle gateway. Custom attributes can also be included by using the AddSpecialField method with the name "CustomAttributeX", where X is a number from 1 to 5. For example: icharge.Config("LitleAdvancedFraudChecksId=ASDFG-AXXXXAB999"); icharge.AddSpecialField("CustomAttribute1", "One"); icharge.AddSpecialField("CustomAttribute2", "Two");

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

This config is used to specify the method used to identify the customer when performing a retail transaction.

The available values are (if not specified, the component will send 'signature' by default):

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

LitleCustomBillingAggregate:   Used to specify an XML aggregate for Custom Billing support within the Litle gateway.

This field is used to specify an XML aggregate for Custom Billing support within the Litle gateway. When specifying custom billing, you can use either the phone or url child.

Below is a sample XML aggregate for the phone child: <phone>555-555-5555</phone> <descriptor>Billing Descriptor</descriptor>

Below is a sample XML aggregate for the url child: <url>retail.url</url> <descriptor>www.retail.com</descriptor>

MerchantAlias:   An additional merchant property used to specify an alias for the merchant.

The HSBC and PayFuse gateway both allow for a merchant alias to be specified (and in some cases it may be required). This field allows you to specify the alias.

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

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

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

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

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

For the WorldPayXML gateway, this configuration setting is optional; it is only needed if you require that the "merchantCode" sent in the request be different from your MerchantLogin (e.g., when processing AMEX transactions, or when supporting multiple currencies).

MerchantPartnersLast4Digits:   The last 4 digits of the card number for a transaction processed via the MerchantPartners gateway.

The last 4 digits of the card number are required to process transactions using a stored profile Id (via MerchantPartnersProfileId) for the MerchantPartners or WorldPay Link gateways.

MerchantPartnersProfileId:   The profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways.

This field is used to specify the Profile Id of a stored profile and is used to process a transaction instead of specifying the card data. A profile is created via the RecurringBilling component and the SubscriptionId response field is used to obtain the profile Id to be set in this field. MerchantPartnersLast4Digits is a required field when using a stored profile. Note this config is only applicable to Sale and Credit transactions processed via the MerchantPartners or WorldPay Link gateways.

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

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

Valid Values:

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

MITAESSeedId:   The Seed Id used to perform AES encryption for the MIT gateway.

This field is used to specify the Seed Id used to perform AES encryption. This field is provided by MIT and is required when performing AES encryption.

MITBranchId:   Branch reference number for the MIT gateway.

This field is used to specify the branch reference number for the MIT gateway (Required).

MITCompanyId:   Company reference number for the MIT gateway.

This field is used to specify the company reference number for the MIT gateway (Required).

MITCountry:   Country of operation for the MIT gateway.

This field is used to specify the country of operation for the MIT gateway (Required).

MITEncryptionAlgorithm:   The Encryption Algorithm to use with the MIT gateway.

This field is used to specify the encryption algorithm to use for the MIT gateway. Encryption will only be performed if an encryption key is specified via MITEncryptionKey. Note when perform AES (1) encryption, you must also set MITAESSeedId.

Applicable values are:

Value Encryption Type
0 (Default) RC4 - The password, cardholder name, card number, expiration month, expiration year, and CVV data will be encrypted.
1 AES - The entire request XML will be encrypted.

MITEncryptionKey:   The Encryption Key to use with the MIT gateway.

This field is used to specify the encryption key for the MIT gateway. When set, the specified key will be used to perform the encryption specified via MITEncryptionAlgorithm.

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

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

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

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

MITRecurring:   Specifies whether to perform a recurring transaction request for the MIT gateway.

When this field is set to 'True', the component will perform a recurring transaction request when Sale is called. The fields required for a Recurring charge transaction are the same as a Sale transaction. The default value is 'False'.

MITTPOperation:   The operation type for the MIT gateway.

This field is used to specify the operation type for the MIT gateway (Required). This value will be provided to you by MIT.

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

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

MonerisNVPAPI:   Indicates whether to use the NVP API for the gwMoneris and gwMonerisUSA gateway.

The field is used to indicate whether to use the NVP API for either the gwMoneris or gwMonerisUSA gateway. When set to true, the NVP API will be used instead of the XML specification. Note that you must set Gateway to either gwMoneris or gwMonerisUSA prior to setting this field. Additionally, if you decide to use the NVP API, this field must be set directly after setting Gateway (as GatewayURL will be updated). Note: The Response Method of the DirectPost configuration must be set to "Displayed as key/value pairs on our server" in the merchant admin console when using the NVP API.

MyVirtualMerchantTransactionType:   Used to override the transaction type to send in a transaction for the MyVirtualMerchant and Converge gateways.

This field is used to override the default transaction type for the MyVirtualMerchant gateway. By default, the component will set the transaction type based on the method called. However this field can be set to override the default value and is particularly useful for creating recurring or installment billing transactions. Below is a list of some of the available transaction types. Note that these additional transaction types require special fields to be added via AddSpecialField. Please consult the Virtual Merchant specifications for details about the required fields.

  • CCCOMPLETE
  • CCADDINSTALL
  • CCADDRECURRING
  • CCINSTALLSALE
  • CCRECURRINGSALE
MyVirtualMerchantUserId:   The MyVirtualMerchant user Id as configured on VirtualMerchant.

This field is used to specify your MyVirtualMerchant user Id which is required (along with MerchantLogin and MerchantPassword) as part of the user authentication.

NetbanxAccountNumber:   Account Number for the Netbanx gateway.

This field is used to specify an account number for the Netbanx gateway which is used in addition to the MerchantLogin and MerchantPassword properties.

NetBillingVersion:   The Version to be sent in the User-Agent heading of a NetBilling gateway request.

The Version portion of the User-Agent HTTP header is required by NetBilling. The default value is "1".

OrbitalAuthReversal:   Indicates whether to perform an authorization reversal when calling VoidTransaction for the Orbital gateway.

This config is used to specify whether VoidTransaction should perform an authorization reversal or void transaction. When this config is set to 'True' and VoidTransaction is called, an authorization reversal transaction will be sent to reverse a previously authorized transaction. The default value is 'False' which sends a void transaction.

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

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

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

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

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

"A" Auto Generate the CustomerRefNum (CustomerId)
"S" Use CustomerRefNum (CustomerId) sent in the request.
"0" Use OrderID (InvoiceNumber) sent in the request.
"D" Use Comments (TransactionDesc) sent in the request.

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

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

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

OrbitalTxRefIdx:   Indentifies the unique components of transactions that have been adjusted more than one time for the Orbital gateway.

This field is used when performing a VoidTransaction to identify unique components of transactions adjusted more than one time. The default value ("NULL") should be submitted when voiding a transaction which has not been adjusted more than once or if the un-captured remainder of a split transaction (partial capture) should be voided. To void a specific partial capture, this field should be set to the value returned in the response for the partial capture. Note that this field will also be populated with the TxRefIdx value returned in a response.

OrbitalVoidAdjustedAmount:   Specifies the amount to void from a previous authoization for the Orbital gateway.

This field is used to specify an amount to adjust a previous authorization when performing a VoidTransaction. Thus the specified amount will be voided (assuming that the amount is not greater than the transaction amount remaining) and the total amount minus the adjusted amount will be the new authorized amount. When a value is not specified, the full amount of will be voided.

PayDirectConvenienceFee:   The total convenience fee charged when using the PayDirect gateway.

This field is used to specify the total convenience fee charged for the transaction when using the PayDirect gateway. This field is always required when using the PayDirect gateway. The sum of this field plus PayDirectMerchantAmount must always equal the value in TransactionAmount. If no values are set for either of these two configs, the component will set PayDirectMerchantAmount to the value specified in TransactionAmount and PayDirectConvenienceFee to "0.00".

PayDirectMerchantAmount:   The MerchantAmount used by the PayDirect gateway.

This field is used to specify the total amount of goods and services for the external client when using the PayDirect gateway. This field is always required when using the PayDirect gateway. The sum of this field plus PayDirectConvenienceFee must always equal the value in TransactionAmount. If no values are set for either of these two configs, the component will set PayDirectMerchantAmount to the value specified in TransactionAmount and PayDirectConvenienceFee to "0.00".

PayDirectSettleMerchantCode:   The Settle Merchant Code required for authorization when using the PayDirect gateway.

This field is used to set Settle Merchant Code assigned by Link2Gov for the Reconciliation of funds. This field is always required when using the PayDirect gateway.

PayerIP:   The IP address of the payer.

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

PayFlowProInquiry:   Submits an Inquiry transaction to the PayFlowPro gateway.

Set this config to the ResponseTransactionId from the transaction you wish to retrieve. You may also call PFPInquiry without setting it to anything. In this case the CustomerId property is required, and the PayFlow Pro gateway will return the most recent transaction for the specified Id.

PayFlowProToken:   Used specify a token to be used instead of card data for the Payflow Pro gateway.

This field is used to specify a token value to perform additional authorizations (via Sale or AuthOnly) and Credits (via Credit) without sending card data again. For the Payflow Pro gateway, token values are the same as the ResponseTransactionId value returned from an authorization. Below is a code example of how this config can be used (note the code starts after the initial Sale or AuthOnly transaction has been performed):

ICharge.Config("PayFlowProToken=" + ICharge.Response.TransactionId); ICharge.TransactionId = "2"; ICharge.TransactionAmount = "10.00"; ICharge.Sale();

PayFlowProUpload:   Submits an Upload transaction to the PayFlowPro gateway.

This is an actionable config which when called will send an upload transaction to the Payflow Pro gateway. An upload transaction is used to store credit card information on the gateway server. Note that billing and shipping information can be saved as well. After a successful upload, ResponseTransactionId will contain the token value that corresponds to the credit card data stored. This token value can then be used to process transactions via PayFlowProToken.

PayJunctionUpdateAmount:   Indicates whether the capture method should send an update amount request when using the PayJunction gateway.

This field allows you to specify whether Capture will send an update amount or a capture request. By default, this value is 'False', which sends a capture request to mark an AuthOnly transaction for capture. This particular function does not allow you to alter the amount but instead just marks the authorized amount (from the AuthOnly transaction) for capture. When this field is set to 'True', the Capture method will send an update amount request allowing you to alter the amount that will be captured. This method can be used after AuthOnly and Sale transactions.

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

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

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

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

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

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

PayPointFreedomAPI:   Indicates whether to use the Freedom API for the gwPayPoint and gwSECPay gateways.

The field is used to indicate whether to use the Freedom API for either the gwPayPoint and gwSECPay gateway. When set to true, the Freedom API will be used instead of the XML Hosted specification. Note that you must set Gateway to either gwPayPoint or gwSECPay prior to setting this field. Additionally, if you decide to use the Freedom API, this field must be set directly after setting Gateway (as GatewayURL will be updated).

PayTraceAddPurchaseCardData:   Sends a Level3 request for the PayTrace gateway.

This config is used to add Purchase Card (Level2 and Level3) Data to an existing sale transaction for the PayTrace gateway. The Level2Aggregate and Level3Aggregate fields can be set to specify the purchase card data you wish to add prior to calling this config. A TransactionId, from the response of the original sale, is required to be specified when calling this config; i.e.: ICharge.Config("PayTraceAddPurchaseCardData=123456789");

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

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

PayTraceJSONCardToken:   The token value for a corresponding card.

This field is used to specify card token value that you retrieved from Protect.js (see PayTrace documentation for details). This field must be set prior to performing a transaction using a token value instead of a Card.

Note that this is only valid when calling Sale or AuthOnly methods and the Gateway property is set to gwPayTraceJSON (117)

PayTraceJSONEncryptionKey:   The Encryption Key to use with the PayTraceJSON gateway.

This field is used to specify the encryption key that you retrieved from Protect.js (see PayTrace documentation for details).

Note that this is only valid when calling Sale or AuthOnly methods and the Gateway property is set to gwPayTraceJSON (117)

PayTraceJSONGetClientKeyToken:   Retrieves a new Client Key (PROTECT AUTH TOKEN) from PayTrace.

This is an Action config. Getting this config will cause the class to obtain a Client Key (PROTECT AUTH TOKEN) from PayTrace. The Client Key will be used to authorize your application to use Protect.js to retrieve Card Token (hpf token) and Encryption Key (enc key). Please see PayTrace documentation for details. This key is valid for 20 minutes. icharge = new Icharge(); icharge.Gateway = IchargeGateways.gwPayTraceJSON; icharge.GatewayURL = "https://api.paytrace.com"; icharge.MerchantLogin = bearerToken; string clientKeyToken = class.Config("PayTraceJSONGetClientKeyToken"); //use this key to obtain "hpf_token" and "enc_key" from Protect.js

PKPaymentToken:   Used to send an Apple Pay PKPaymentToken to the gateway.

This configuration setting is used to send an Apple Pay PKPaymentToken containing a user's credentials to a gateway. The setting should be set to the full JSON contents of the PKPaymentToken, like: icharge.Config("PKPaymentToken={\"version\":\"EC_v1\",\"data\":\"...\",\"signature\":\"...\",\"header\":{\"applicationData\":\"...\",\"transactionId\":\"...\",\"ephemeralPublicKey\":\"...\",\"publicKeyHash\":\"...\"}}"); PKPaymentToken is currently only supported in gwLitle.

QBMSMobile:   Whether or not this transaction is being sent from a mobile device.

When using the QBMS gateway, this setting specified whether a transaction is being sent from a mobile device ("True") or not ("False"). The default value is "False".

QBPaymentsMobile:   Whether or not this transaction is being sent from a mobile device.

When using the QBPayments gateway, this setting specified whether a transaction is being sent from a mobile device ("True") or not ("False"). The default value is "False".

RawRequest:   Returns the data that was sent to the gateway.

This may be queried after a call to any method that sends data to the gateway. This will return the request data that was sent to the gateway which may be useful for troubleshooting purposes. For instance: component.Sale() MyString = component.Config("RawRequest")

RawResponse:   Returns the data that was received from the gateway.

This may be queried after a call to any method that sends data to the gateway. This will return the response that was received to the gateway which may be useful for troubleshooting purposes. For instance: component.Sale() MyString = component.Config("RawResponse")

RecurringIndicator:   Marks a request as a recurring transaction.

This configuration setting can be set to indicate that a request is a recurring transaction. For a list of supported values for a gateway, please see the "ICharge Gateway Setup and Required Properties" page. This configuration setting is used by the QBPayments gateway.

SagePayCreateToken:   Sends a create token request to the SagePay gateway.

This is an action config which when called will send a create token request to the SagePay gateway. A successful response will contain the SagePayToken for the specified CardNumber. Note: when using this config you must set the "VPSProtocol" SpecialFields to "3.00".

SagePayRemoveToken:   Sends a remove token request to the SagePay gateway.

This is an action config which when called will send a remove token request to the SagePay gateway. The specified SagePayToken will be removed from the SagePay server. Note: when using this config you must set the "VPSProtocol" SpecialFields to "3.00".

SagePayRepeat:   Performs a Repeat transaction for the SagePay gateway.

This is an action config which when called will perform a Repeat transaction for the SagePay gateway. The 'TransactionId' from a previous authorization response, that you would like to repeat for the card associated with the transaction, must be specified as a parameter. For example, a Repeat transaction using a TransactionId of 123 would be: ICharge.Config("SagePayRepeat=123").

"RelatedSecurityKey" and "RelatedVendorTXCode" special fields are required for Repeats. These are parsed out of the original authorization response.

SagePayRequestToken:   Specifies whether to request a token when performing an Auth or Sale when using the SagePay gateway.

This field allows you to specify whether to have SagePay generate a token and send it in the response. When set to 'True', a token will be returned in a Sale or AuthOnly response and can be accessed via SagePayToken. Note: when using this config you must set the "VPSProtocol" SpecialFields to "3.00". The default value is 'False'.

SagePayStoreToken:   Specifies whether to store a token when using the SagePay gateway.

This field allows you to specify whether to store a token and on the SagePay server. This field must be set to 'True' to have the token remain on the server after use. Otherwise, if set to 'False', the Token will be used to perform the requested transaction and then deleted from the server. Note: when using this config you must set the "VPSProtocol" SpecialFields to "3.00". The default value is 'False'.

SagePayToken:   The token value for a corresponding card when using the SagePay gateway.

This field is used to retrieve or specify a token value. This field will be populated after a call to either SagePayCreateToken or SagePayRequestToken is set to 'True' and a Sale or AuthOnly request is performed. This field can be specified prior to calling SagePayRemoveToken or performing a transaction using a token value instead of Card.

SagePayUseAbort:   Indicates whether to use Abort or Void for void transactions.

The SagePay gateway (formerly Protx) has two different void transaction types. If SagePayUseAbort is set to false (default), void transactions are sent with the VOID transaction type. If true, void transactions are sent with the ABORT transaction type. Aborts are used for voiding auth-only transactions, and voids are used for voiding sale/capture transactions.

The ResponseTransactionId from the original request must be passed as the parameter in the VoidTransaction method. In addition, the following Special Fields are required for both Abort and Void transactions:

SecurityKey Security Key from original transaction response.
TxAuthNo ResponseApprovalCode from original transaction response.

Shift4AuthToken:   Specifies the Auth Token when making an Access Token request to the Shift4 gateway.

This configuration setting is used to specify the AuthToken to include when making an Access Token Exchange request to the Shift4 gateway. An access token is required for any other interaction with the gateway.

Shift4ClientGuid:   Specifies the Client Guid when making an Access Token request to the Shift4 gateway.

This configuration setting is used to specify the Client Guid to include when making an Access Token Exchange request to the Shift4 gateway. An access token is required for any other interaction with the gateway.

Shift4GetAccessToken:   Performs an Access Token Exchange request with the Shift4 gateway.

This is an action config which when called will perform an Access Token Exchange request with the Shift4 gateway. Before calling this config, the MerchantLogin property and the Shift4InterfaceName, Shift4InterfaceVersion, Shift4AuthToken, and Shift4ClientGuid configuration settings should be set. MerchantPassword will be set to the access token if the request is successful. Note that an AuthToken can only be exchanged for an access token once, so be sure to save the result of the request for future use.

Shift4InterfaceName:   Specifies the name of the interface for the Shift4 gateway.

Shift4 requires you to identify the interface that you are using to communicate with the API (i.e. your application). This configuration setting is used to specify the name of the interface.

Shift4InterfaceVersion:   Specifies the version of the interface for the Shift4 gateway.

Shift4 requires you to identify the interface that you are using to communicate with the API (i.e. your application). This configuration setting is used to specify the version of the interface.

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

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

SurchargeAmount:   Used to specify the amount of the surcharge for the transaction.

This configuration setting is used when there is an additional fee included in the transaction to specify the amount of that fee. This field is used by the Shift4 gateway.

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

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

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

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

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

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

For Shift4 this field is more complicated, and should be set to a JSON object matching the value of the device.capability field from the Shift4 documentation.

TerminalId:   Terminal Id value sent in the transaction.

Many gateways allow/require an Id (terminal, developer, client, user, etc) sent in addition to the MerchantLogin and MerchantPassword. This config is supported for the following gateways: Adyen (required), BarClay (required), BluePay, Nuvei (required), Heartland, HSBC (required), Orbital, PayFuse (required), PaymentWorksuite, Planet Payment (required), SkipJack, and WorldPayXML (required). For Orbital, this config is optional but if not specified a value of '001' will be sent. For Heartland, this config is used for MasterCard's Card Accepter Terminal Id requirement.

TerminalManufacturer:   The manufacturer of the terminal used to submit the transaction.

This config is used to specify the manufacturer of the terminal (device) being used in a retail transaction. This config is used with the Shift4 gateway.

TerminalModel:   The model of the terminal used to submit the transaction.

This config is used to specify the model of the terminal (device) being used in a retail transaction. This config is used with the Shift4 gateway.

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

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

The available values for Authorize.NET are (required):

Value Description
1 Unknown
2 Unattended Terminal
3 Self Service Terminal
4 Electronic Cash Register
5 Personal Computer- Based Terminal
6 AirPay
7 Wireless POS
8 Website
9 Dial Terminal
10 Virtual Terminal

The available values for USA EPay are (required):

Value Description
POS Cash Register
StandAlone Self Service Terminal
Unattended Unattended Terminal (i.e. Gas Pump)
Unknown Unknown

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

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

TipAmount:   Used to specify the amount of the tip for the transaction.

This configuration setting is used when there is a tip included in the transaction to specify the amount of the tip. This field is used by the Shift4 gateway.

USAEPayPerformVoidRelease:   Specifies whether to perform a void or void:release transaction.

This field is used to specify whether you wish to perform a void or void:release transaction when VoidTransaction is called. When set to "True", the void:release transaction will be sent. The void:release transaction is the same as a void with the exception that the cardholders bank is notified immediately that they can release the funds. The regular void transaction, on the other hand, does not notify the cardholder bank until the batch closes. The default value is "False" (so a regular void transaction is sent).

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

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

UserId:   Used to specify an Id for the API user.

This configuration setting is used to specify an Id for the user, if one is required. Used by the Barclay, Ingenico, Metrobank, and Shift4 gateways. For the Barclay and Ingenico gateways, this configuration setting should contain the name of your application (API) user. For Shift4 or Metrobank, this is the clerk or terminal operator.

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

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

The current element is specified via the XPath configuration option.

This configuration option is read-only.

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

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

The current element is specified via the XPath configuration option.

This configuration option is read-only.

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

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

The current element is specified via the XPath configuration option.

This configuration option is read-only.

XElement:   The name of the current element.

The current element is specified via the XPath configuration option.

This configuration option is read-only.

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

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

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

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

Example (Setting XPath for XML)

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

Example (Setting XPath for JSON)

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

XText:   The text of the current element.

The current element is specified in the XPath configuration option.

This configuration option is read-only.

HTTP Config Settings

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

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

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

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

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

The default value is True.

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

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when 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 (Retail Class)

Retail Errors

159   Invalid form variable index (out of range).
501   Data field invalid length.
502   Data field invalid format.
503   Data field out of range.
504   Luhn digit check failed.
505   Card date invalid.
506   Card expired.
507   Card type unknown.
510   No gateway specified.
511   Invalid data entered.
512   Truncated response.
513   Invalid response.
514   A Special Field is required for this transaction type.
535   Signature verification failed.
542   Error computing MD5 hash for Authorize.Net

CardValidator Errors

504   Luhn digit check failed.
505   Card date invalid.
506   Card expired.
703   Invalid CardNumber format (contains letters or unknown characters).
704   Could not determine the Credit Card type.
705   Error parsing TrackData. Format cannot be determined.

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]