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.
Syntax
inpay.Retail
Remarks
The Retail class allows you to use multiple Internet Payment Gateways through one interface and one class. This allows for easy migration from one gateway to another, as well as quick integration into applications or web services.
The Retail class allows your website to securely perform credit card transactions without the need to redirect to a third-party site. All transactions are accomplished through a secure HTTPS Post to any supported gateway. The secure response is received and then stored in the class's response properties. Any web site on a standard HTTP server or any stand-alone application can process transactions without the need for a secure server or third-party intervention.
The first thing you must do is select one of the many gateways supported by the Retail class, and set up an account with that gateway vendor. Once you have an account set up with a valid (or test) login Id and password, you can use the Retail class.
To begin, set the Gateway property to the gateway you wish to use. If this gateway supports an alternate URL to send test transactions to, set the GatewayURL at this time.
Next, set the MerchantLogin (and for some gateways the MerchantPassword). These are supplied by your gateway vendor when you set up an account.
Now you are ready to process transactions. For each transaction, you can set the Card and TransactionAmount properties. For swiped card transactions you can set MagneticStripe or for manually entered transactions you can set Number, ExpMonth, ExpYear. Most gateways will also require additional properties, such as Address, FirstName, LastName, InvoiceNumber, etc. Any additional required properties are listed in the Gateway property description.
Once these properties are set, you may run validity checks on the card data with the AVSOnly method, or simply authorize the transaction with the Sale method. If your Gateway supports them, you may also perform a wide variety of transaction types such as VoidTransaction, Refund, Credit, or Force. Please review the method pages for further details about these methods and their designed functionality.
The following gateways are supported by the Retail class:
Gateway | Home page |
No Gateway (0) | n/a |
Authorize.Net AIM (1) | http://www.authorize.net |
eProcessing Transparent Database Engine (2) | http://www.eProcessingNetwork.com |
iTransact RediCharge HTML (4) | http://www.itransact.com |
NetBilling DirectMode (5) | http://www.netbilling.com |
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.
AuthCode | Authorization code from a previous transaction. |
Card | Contains the customer's credit card information. |
Customer | Contains the customer's name, address, and other identifying information. |
Gateway | Gateway to process transactions with. |
GatewayURL | Default URL for a specific Gateway . |
InvoiceNumber | Merchant-generated invoice number. |
Level2Aggregate | The level 2 aggregate containing the data to be sent in the request. |
Level3Aggregate | The level 3 aggregate containing the data to be sent in the request. |
MerchantLogin | Merchant's Gateway login. |
MerchantPassword | Merchant's Gateway password. |
Proxy | A set of properties related to proxy access. |
Response | Contains the response to the authorization. |
ShippingInfo | Contains the customer's shipping name, address, and other identifying information. |
SpecialFields | A list of additional fields to send in the request. |
SSLAcceptServerCert | Instructs the class to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during Secure Sockets Layer (SSL) negotiation. |
SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCert | The server certificate for the last established connection. |
TestMode | Turns test mode on and off for transactions sent to the current Gateway . |
Timeout | A timeout for the class. |
TransactionAmount | Purchase amount for an authorization transaction. |
TransactionDesc | Description of goods purchased. |
TransactionId | Merchant-generated transaction Id used for all transactions. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AddSpecialField | Adds a special field name and the corresponding value. |
AuthOnly | Initiates an authorization-only request transaction. |
AVSOnly | Used to check the validity of the card without authorizing funds. |
Capture | Captures a previously authorized transaction. |
Config | Sets or retrieves a configuration setting. |
Credit | Credits a customer's card. |
DoEvents | This method processes events from the internal message queue. |
Force | Used when authorization cannot be obtained online. |
GetResponseVar | Parses additional information out of the response. |
Interrupt | Interrupts the current action. |
Refund | Refunds a previously captured transaction. |
Reset | Clears all properties to their default values. |
ResetSpecialFields | Resets all special fields to the default settings. |
Sale | Initiates an Sale transaction (authorization and capture). |
VoidTransaction | Voids a previously authorized transaction. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
3DSAuthenticationStatus | Indicates whether a transaction qualifies as a ThreeDSecure (3DS) authenticated transaction. |
3DSCAVV | Cardholder Authentication Verification Value from a 3D Secure authentication. |
3DSDSTransactionId | Directory server transaction Id from a 3D Secure authentication. |
3DSECI | Electronic Commerce Indicator. |
3DSEnrollmentStatus | Indicates whether 3D Secure authentication is available for the cardholder. |
3DSXID | TransactionId from a 3D Secure authentication. |
AllowPartialAuths | Specifies whether partial authorizations are allowed. |
AmountFormat | Used to set the input format for TransactionAmount. |
ApplePayData | The Base-64 encoded data containing the encrypted payment data from Apple for use when performing Apple Pay transactions. |
AuthNetShipToCompany | The name of the company associated with the customer's shipping address. |
AuthNetSplitTenderId | Authorize.Net assigned id for partially authorized transactions. |
BluePayKSN | The Key Serial Number (KSN) used to encrypt the card magnetic stripe data for the BluePay gateway. |
BluePayMasterId | Used to reference a previous transaction in BluePay. |
BluePayPreEncryptedTrackLength | The length of the magnetic stripe data prior to encryption for the BluePay gateway. |
BluePayUpdate | Used to perform an Update transaction for BluePay. |
CardEncrypted | Specifies whether the card magnetic stripe data is encrypted. |
CardholderPresentCode | Specifies the way in which transaction took place. |
CardIssueNumber | Special Issue Number used for Switch and Solo cards. |
CardPresent | Specifies whether the card is present during the transaction. |
CardStartMonth | Used for some international cards. |
CardStartYear | Used for some international cards. |
CardType | Type of credit card being used in this transaction. |
CAVVResponse | Contains CAVV response value returned by the gateway. |
COFPermission | Indicates if the customer gave permission to make a Card On File transaction. |
ConvenienceFee | The total convenience fee charged for a transaction. |
CurrencyCode | Currency code for the currency of the transaction. |
CurrencyExponent | Currency exponent to be used in conjunction with the Currency code of the transaction. |
CyberSourceAuthToken | The request token from a previous authorization for the CyberSource gateway. |
CyberSourceProfileId | The Id of a Customer's Profile stored within the CyberSource gateway. |
CyberSourceVoidMode | Indicates whether to perform a Void or Reversal. |
CyberSourceXMLEscape | Determines whether to XML escape the CyberSource gateway request field values. |
DebitKSN | Clear-text Key Sequence Number retrieved from a PIN pad. |
DebitPIN | DUKPT DES encrypted pin block, retrieved from a PIN pad. |
DynamicDescriptor | A merchant defined transaction description which appears on the customer's credit card statement. |
EscapeXML | Automatically escape data within XML tags. |
FDMSCurrentBalance | Contains the current card balance value returned in a response for the First Data E4, Payeezy, and Bank Of America gateways. |
FDMSGiftCardTransactionType | Specifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways. |
FDMSKeyId | The Key Id that corresponds to the HMAC Key for the First Data E4, Payeezy, and Bank Of America gateways. |
FDMSProcessGiftCard | Specifies whether the card being processed is a gift card for the First Data E4, Payeezy, and Bank Of America gateways. |
FDMSTransArmorToken | The Transarmor token that replaces a card number and used for transaction processing. |
FDMSWalletProviderId | Specifies the transaction type to perform on a gift card for the First Data E4, Payeezy, and Bank Of America gateways. |
GlobalIrisRefundPassword | The Refund password for the Global Iris gateway. |
GoEMerchantUseGatewayId | Indicates whether to send a password or gateway Id for the GoEMerchant gateway. |
HashAlgorithm | Algorithm used for hashing. |
HashSecret | Security key used to generate a hash for gateways supporting such functionality. |
HeartlandDeveloperId | Optional DeveloperId field used by the Heartland gateway. |
HeartlandDeviceId | DeviceId field required by the Heartland gateway. |
HeartlandLicenseId | LicenseId field required by the Heartland gateway. |
HeartlandReversalAmount | The settlement amount to be used when performing a reversal for the Heartland gateway. |
HeartlandSecretAPIKey | Specifies the secret key to be used for authentication with Heartland. |
HeartlandShipDay | Ship day field required by the Heartland gateway e-commerce/direct marketing transactions. |
HeartlandShipMonth | Ship month field required by the Heartland gateway e-commerce/direct marketing transactions. |
HeartlandSiteId | SiteId field required by the Heartland gateway. |
HeartlandSiteTrace | Optional transaction identifier for the Heartland gateway. |
HeartlandTokenMapping | The type of token to return when using Tokenization with the Heartland gateway. |
HeartlandTokenValue | Used to retrieve or specify a Heartland token value. |
HeartlandVersionNumber | Optional VersionNumber field used by the Heartland gateway. |
LitleAdvancedFraudChecksId | Used to specify the Id for use in the AdvancedFraudChecks element for the Litle gateway. |
LitleCardholderID | Describes the method used to identify the cardholder at the point of sale for the Litle gateway. |
LitleCustomBillingAggregate | Used to specify an XML aggregate for Custom Billing support within the Litle gateway. |
MerchantAlias | An additional merchant property used to specify an alias for the merchant. |
MerchantCode | A gateway-supplied merchant number, code, or Id. |
MerchantPartnersLast4Digits | The last 4 digits of the card number for a transaction processed via the MerchantPartners gateway. |
MerchantPartnersProfileId | The profile Id to be used to process a transaction via the MerchantPartners or WorldPay Link gateways. |
MerchantPartnersReaderType | The reader type used to read and encrypt a swiped card for the MerchantPartners or WorldPay Link gateways. |
MITAESSeedId | The Seed Id used to perform AES encryption for the MIT gateway. |
MITBranchId | Branch reference number for the MIT gateway. |
MITCompanyId | Company reference number for the MIT gateway. |
MITCountry | Country of operation for the MIT gateway. |
MITEncryptionAlgorithm | The Encryption Algorithm to use with the MIT gateway. |
MITEncryptionKey | The Encryption Key to use with the MIT gateway. |
MITFlag | For the MIT framework - Used to indicate that a transaction is merchant initiated. |
MITPriorTransId | For the MIT framework - Used to specify a prior transaction id to be referenced in a merchant initiated transaction. |
MITRecurring | Specifies whether to perform a recurring transaction request for the MIT gateway. |
MITTPOperation | The operation type for the MIT gateway. |
MITType | For the MIT framework - Indicates the type of transaction being requested in a Merchant-Initiated Transaction (MIT). |
MonerisNVPAPI | Indicates whether to use the NVP API for the gwMoneris and gwMonerisUSA gateway. |
MyVirtualMerchantTransactionType | Used to override the transaction type to send in a transaction for the MyVirtualMerchant and Converge gateways. |
MyVirtualMerchantUserId | The MyVirtualMerchant user Id as configured on VirtualMerchant. |
NetbanxAccountNumber | Account Number for the Netbanx gateway. |
NetBillingVersion | The Version to be sent in the User-Agent heading of a NetBilling gateway request. |
OrbitalAuthReversal | Indicates whether to perform an authorization reversal when calling VoidTransaction for the Orbital gateway. |
OrbitalConnectionPassword | Orbital Connection Password field used by the Orbital gateway. |
OrbitalConnectionUsername | Orbital Connection Username field used by the Orbital gateway. |
OrbitalCustomerProfileFromOrderInd | Customer Profile Number generation Options for the Orbital gateway. |
OrbitalCustomerProfileOrderOverrideInd | Indicator to specify how the CustomerId is leveraged to populate other data sets for the Orbital gateway. |
OrbitalTxRefIdx | Indentifies the unique classes of transactions that have been adjusted more than one time for the Orbital gateway. |
OrbitalVoidAdjustedAmount | Specifies the amount to void from a previous authoization for the Orbital gateway. |
PayDirectConvenienceFee | The total convenience fee charged when using the PayDirect gateway. |
PayDirectMerchantAmount | The MerchantAmount used by the PayDirect gateway. |
PayDirectSettleMerchantCode | The Settle Merchant Code required for authorization when using the PayDirect gateway. |
PayerIP | The IP address of the payer. |
PayFlowProInquiry | Submits an Inquiry transaction to the PayFlowPro gateway. |
PayFlowProToken | Used specify a token to be used instead of card data for the Payflow Pro gateway. |
PayFlowProUpload | Submits an Upload transaction to the PayFlowPro gateway. |
PayJunctionUpdateAmount | Indicates whether the capture method should send an update amount request when using the PayJunction gateway. |
PaymentWorkSuiteClientCode | The 3DSI assigned client code sent in a request to the PaymentWorksuite gateway. |
PaymentWorkSuiteLocationCode | The 3DSI assigned location code sent in a request to the PaymentWorksuite gateway. |
PaymentWorkSuiteMerchantCode | The 3DSI assigned merchant code sent in a request to the PaymentWorksuite gateway. |
PayPointFreedomAPI | Indicates whether to use the Freedom API for the gwPayPoint and gwSECPay gateways. |
PayTraceAddPurchaseCardData | Sends a Level3 request for the PayTrace gateway. |
PayTraceIntegratorId | Used to specify the Integrator Id value assigned by the PayTrace gateway. |
PayTraceJSONCardToken | The token value for a corresponding card. |
PayTraceJSONEncryptionKey | The Encryption Key to use with the PayTraceJSON gateway. |
PayTraceJSONGetClientKeyToken | Retrieves a new Client Key (PROTECT AUTH TOKEN) from PayTrace. |
PKPaymentToken | Used to send an Apple Pay PKPaymentToken to the gateway. |
QBMSMobile | Whether or not this transaction is being sent from a mobile device. |
QBPaymentsMobile | Whether or not this transaction is being sent from a mobile device. |
RawRequest | Returns the data that was sent to the gateway. |
RawResponse | Returns the data that was received from the gateway. |
RecurringIndicator | Marks a request as a recurring transaction. |
SagePayCreateToken | Sends a create token request to the SagePay gateway. |
SagePayRemoveToken | Sends a remove token request to the SagePay gateway. |
SagePayRepeat | Performs a Repeat transaction for the SagePay gateway. |
SagePayRequestToken | Specifies whether to request a token when performing an Auth or Sale when using the SagePay gateway. |
SagePayStoreToken | Specifies whether to store a token when using the SagePay gateway. |
SagePayToken | The token value for a corresponding card when using the SagePay gateway. |
SagePayUseAbort | Indicates whether to use Abort or Void for void transactions. |
Shift4AuthToken | Specifies the Auth Token when making an Access Token request to the Shift4 gateway. |
Shift4ClientGuid | Specifies the Client Guid when making an Access Token request to the Shift4 gateway. |
Shift4GetAccessToken | Performs an Access Token Exchange request with the Shift4 gateway. |
Shift4InterfaceName | Specifies the name of the interface for the Shift4 gateway. |
Shift4InterfaceVersion | Specifies the version of the interface for the Shift4 gateway. |
StoreCardOnFile | For the Stored Credentials framework - Used to indicate that the merchant will be storing the customer's card on file (COF). |
SurchargeAmount | Used to specify the amount of the surcharge for the transaction. |
TerminalCapability | The capability of the terminal that is used to submit the transaction. |
TerminalId | Terminal Id value sent in the transaction. |
TerminalManufacturer | The manufacturer of the terminal used to submit the transaction. |
TerminalModel | The model of the terminal used to submit the transaction. |
TerminalType | The terminal type that is used to submit the transaction. |
TipAmount | Used to specify the amount of the tip for the transaction. |
USAEPayPerformVoidRelease | Specifies whether to perform a void or void:release transaction. |
UseCardOnFile | For the Stored Credentials framework - Used to indicate that the merchant is using stored card on file (COF) information for the request. |
UserId | Used to specify an Id for the API user. |
XChildrenCount | The number of child elements of the current element. |
XChildrenName[x] | The name of the child element. |
XChildrenXText[x] | The inner text of the child element. |
XElement | The name of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to True the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxHeaders | Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusCode | The status code of the last response from the server. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the class will close the upload or download stream after the transfer. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallListener | If true, the class binds to a SOCKS firewall as a server (TCPClient only). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
SSLContextProtocol | The protocol used when getting an SSLContext instance. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLServerCACerts | A newline separated list of CA certificates to use during SSL server certificate validation. |
SSLTrustManagerFactoryAlgorithm | The algorithm to be used to create a TrustManager through TrustManagerFactory. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
GUIAvailable | Whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseDaemonThreads | Whether threads created by the class are daemon threads. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AuthCode Property (Retail Class)
Authorization code from a previous transaction.
Syntax
public String getAuthCode(); public void setAuthCode(String authCode);
Default Value
""
Remarks
Some gateways require the merchant to include the ApprovalCode 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)
Card Property (Retail Class)
Contains the customer's credit card information.
Syntax
public CCCard getCard(); public void setCard(CCCard card);
Remarks
This must be set to an instance of the CCCard type, which will contain information about the credit card to be charged. This may include a MagneticStripe for swiped cards, or a Number, ExpMonth, and ExpYear for manually entered cards. (EntryDataSource indicates which set of properties will be used). See the CCCard type for more information.
This property is not available at design time.
Please refer to the CCCard type for a complete list of fields.Customer Property (Retail Class)
Contains the customer's name, address, and other identifying information.
Syntax
public EPCustomer getCustomer(); public void setCustomer(EPCustomer customer);
Remarks
This property must be set to an instance of the EPCustomer type, which will contain information that identifies the customer. This information will be used by the Gateway for fraud checking purposes. See the EPCustomer type for more information.
All gateways require at the minimum the FirstName, LastName, FullName (the customer's name as it appears on the card), Address, City, State, and Zip. The following table shows which gateways require which additional Customer properties:
Gateway | Country | Id | Phone | |
gwGoRealTime (4) | X | |||
gwITransact (8) | X | X | X | |
gwSkipjack (22) | X | X | ||
gwECHOnline (23) | X | |||
gwPayFlowLink (28) | X | X | X | |
gwCyberCash (41) | X | X | X | |
gwCyberSource (46) | X | |||
gwGoEMerchant (48) | X | |||
gwNexCommerce (53) | X | X | X | |
gwWorldPay (54) | X | |||
gwPayGea (56) | X | X |
This property is not available at design time.
Please refer to the EPCustomer type for a complete list of fields.Gateway Property (Retail Class)
Gateway to process transactions with.
Syntax
public int getGateway(); public void setGateway(int gateway); Enumerated values: public final static int rgwNoGateway = 0; public final static int rgwAuthorizeNet = 1; public final static int rgwEprocessing = 2; public final static int rgwITransact = 4; public final static int rgwNetBilling = 5; public final static int rgwPayFlowPro = 6; public final static int rgwUSAePay = 7; public final static int rgwPlugNPay = 8; public final static int rgwPlanetPayment = 9; public final static int rgwMPCS = 10; public final static int rgwRTWare = 11; public final static int rgwECX = 12; public final static int rgwBankOfAmerica = 13; public final static int rgwMerchantAnywhere = 15; public final static int rgwSkipjack = 16; public final static int rgwTrustCommerce = 19; public final static int rgwPayFuse = 21; public final static int rgwLinkPoint = 24; public final static int rgwFastTransact = 27; public final static int rgwNetworkMerchants = 28; public final static int rgwPRIGate = 30; public final static int rgwMerchantPartners = 31; public final static int rgwFirstData = 33; public final static int rgwYourPay = 34; public final static int rgwACHPAyments = 35; public final static int rgwForte = 36; public final static int rgwCyberSource = 37; public final static int rgwGoEMerchant = 39; public final static int rgwChase = 41; public final static int rgwNexCommerce = 42; public final static int rgwTransactionCentral = 44; public final static int rgwSterling = 45; public final static int rgwPayJunction = 46; public final static int rgwMyVirtualMerchant = 49; public final static int rgwVerifi = 54; public final static int rgwMerchantESolutions = 56; public final static int rgwPayLeap = 57; public final static int rgwWorldPayXML = 59; public final static int rgwProPay = 60; public final static int rgwQBMS = 61; public final static int rgwHeartland = 62; public final static int rgwLitle = 63; public final static int rgwBrainTree = 64; public final static int rgwJetPay = 65; public final static int rgwHSBC = 66; public final static int rgwBluePay = 67; public final static int rgwPayTrace = 70; public final static int rgwTransNationalBankcard = 74; public final static int rgwFirstDataE4 = 80; public final static int rgwBluefin = 82; public final static int rgwPayscape = 83; public final static int rgwPayDirect = 84; public final static int rgwWorldPayLink = 87; public final static int rgwPaymentWorkSuite = 88; public final static int rgwFirstDataPayPoint = 90; public final static int rgwPayeezy = 94; public final static int rgwAuthorizeNetXML = 96; public final static int rgwPhoeniXGate = 97; public final static int rgwRepay = 98; public final static int rgwBASYS = 106; public final static int rgwQBPayments = 113; public final static int rgwShift4 = 114; public final static int rgwHeartlandPortico = 116; public final static int rgwPayTraceJSON = 117;
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, Name, and Value properties with default data for the selected gateway. The following table shows the currently supported gateways, as well as the corporate home page for each.
Gateway | Home page |
No Gateway (0) | n/a |
Authorize.Net AIM (1) | http://www.authorize.net |
eProcessing Transparent Database Engine (2) | http://www.eProcessingNetwork.com |
iTransact RediCharge HTML (4) | http://www.itransact.com |
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/ |
GatewayURL Property (Retail Class)
Default URL for a specific Gateway .
Syntax
public String getGatewayURL(); public void setGatewayURL(String gatewayURL);
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.
InvoiceNumber Property (Retail Class)
Merchant-generated invoice number.
Syntax
public String getInvoiceNumber(); public void setInvoiceNumber(String invoiceNumber);
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.
Level2Aggregate Property (Retail Class)
The level 2 aggregate containing the data to be sent in the request.
Syntax
public String getLevel2Aggregate(); public void setLevel2Aggregate(String level2Aggregate);
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.
Level3Aggregate Property (Retail Class)
The level 3 aggregate containing the data to be sent in the request.
Syntax
public String getLevel3Aggregate(); public void setLevel3Aggregate(String level3Aggregate);
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.
MerchantLogin Property (Retail Class)
Merchant's Gateway login.
Syntax
public String getMerchantLogin(); public void setMerchantLogin(String merchantLogin);
Default Value
""
Remarks
This is the login Id supplied by the Gateway you signed up with to process credit card transactions.
MerchantPassword Property (Retail Class)
Merchant's Gateway password.
Syntax
public String getMerchantPassword(); public void setMerchantPassword(String merchantPassword);
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.
Proxy Property (Retail Class)
A set of properties related to proxy access.
Syntax
public Proxy getProxy(); public void setProxy(Proxy proxy);
Remarks
This property contains fields describing the proxy through which the class will attempt to connect.
Please refer to the Proxy type for a complete list of fields.Response Property (Retail Class)
Contains the response to the authorization.
Syntax
public EPResponse getResponse();
Remarks
This property will contain the response returned from the Gateway server. It should be inspected (and logged) after a call to AuthOnly, Sale, Capture, Credit, Force, or VoidTransaction. The EPResponse type contains the following fields:
ApprovalCode | Contains an authorization code for an approved transaction. |
Approved | Indicates whether the transaction was successful (True) or unsuccessful (False). |
ApprovedAmount | The amount approved for the transaction, this is the amount actually charged to the credit card. |
AVSResult | Contains the Address Verification System result code. Used for fraud detection. |
Code | Indicates the success or failure of the transaction. |
CVVResult | Contains the returned CVV result code if it was requested. Used for fraud detection. |
Data | Contains the raw response from the host. |
ErrorCode | Additional code returned for declined or failed transactions. |
ErrorText | Description of the error which occurred. |
InvoiceNumber | Merchant-generated invoice number echoed back in the response. |
ProcessorCode | Return code generated by the processor, or additional gateway response code that may contain more information beyond "Approved" or "Declined". |
Text | Contains a human-readable message explaining the code. |
TransactionId | Host-generated transaction identifier, used for Captures, Credits, or Voids. |
Note that many gateways do not return values in all of these fields. Any field in the Data which has not been parsed into these Response fields may be retrieved with the GetResponseVar method.
This property is read-only and not available at design time.
Please refer to the EPResponse type for a complete list of fields.ShippingInfo Property (Retail Class)
Contains the customer's shipping name, address, and other identifying information.
Syntax
public EPShipInfo getShippingInfo(); public void setShippingInfo(EPShipInfo shippingInfo);
Remarks
This property must be set to an instance of the EPShipInfo type, which will contain information that specifies the shipping information for the order. See the EPShipInfo type for more information.
This property is not available at design time.
Please refer to the EPShipInfo type for a complete list of fields.SpecialFields Property (Retail Class)
A list of additional fields to send in the request.
Syntax
public EPSpecialFieldList getSpecialFields(); public void setSpecialFields(EPSpecialFieldList specialFields);
Remarks
This property contains a collection of EPSpecialField name/value pair objects. The Gateway may put some special configuration fields into this property which you can edit or add to. This allows you to extend the functionality of the class by adding fields for which there are not currently properties for.
This property is not available at design time.
Please refer to the EPSpecialField type for a complete list of fields.SSLAcceptServerCert Property (Retail Class)
Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
Syntax
public Certificate getSSLAcceptServerCert(); public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);
Remarks
If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.
You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.
Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.
Please refer to the Certificate type for a complete list of fields.SSLCert Property (Retail Class)
The certificate to be used during Secure Sockets Layer (SSL) negotiation.
Syntax
public Certificate getSSLCert(); public void setSSLCert(Certificate SSLCert);
Remarks
This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.
Please refer to the Certificate type for a complete list of fields.SSLProvider Property (Retail Class)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2;
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 as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.
SSLServerCert Property (Retail Class)
The server certificate for the last established connection.
Syntax
public Certificate getSSLServerCert();
Remarks
This property contains the server certificate for the last established connection.
SSLServerCert is reset every time a new connection is attempted.
This property is read-only.
Please refer to the Certificate type for a complete list of fields.TestMode Property (Retail Class)
Turns test mode on and off for transactions sent to the current Gateway .
Syntax
public boolean isTestMode(); public void setTestMode(boolean testMode);
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 throws an exception.
Timeout Property (Retail Class)
A timeout for the class.
Syntax
public int getTimeout(); public void setTimeout(int timeout);
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).
TransactionAmount Property (Retail Class)
Purchase amount for an authorization transaction.
Syntax
public String getTransactionAmount(); public void setTransactionAmount(String transactionAmount);
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.
TransactionDesc Property (Retail Class)
Description of goods purchased.
Syntax
public String getTransactionDesc(); public void setTransactionDesc(String transactionDesc);
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.
TransactionId Property (Retail Class)
Merchant-generated transaction Id used for all transactions.
Syntax
public String getTransactionId(); public void setTransactionId(String transactionId);
Default Value
""
Remarks
This property is used to send a merchant-generated transaction id to the Gateway, if the gateway supports that feature.
AddSpecialField Method (Retail Class)
Adds a special field name and the corresponding value.
Syntax
public void addSpecialField(String name, String value);
Remarks
Please refer to the Name and Value fields for more information on form variables and how they are managed.
AuthOnly Method (Retail Class)
Initiates an authorization-only request transaction.
Syntax
public void authOnly();
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 throws an exception.
AVSOnly Method (Retail Class)
Used to check the validity of the card without authorizing funds.
Syntax
public void AVSOnly();
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 throws an exception.
Capture Method (Retail Class)
Captures a previously authorized transaction.
Syntax
public void capture(String transactionId, String 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 TransactionId 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 InvoiceNumber rather than the TransactionId.
The SecurePay gateway does not require the TransactionId for captures. Instead, you must send the ApprovalCode 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 ApprovalCode 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 ApprovalCode is not applicable.
Config Method (Retail Class)
Sets or retrieves a configuration setting.
Syntax
public String config(String 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 (Retail Class)
Credits a customer's card.
Syntax
public void credit();
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 (Retail Class)
This method processes events from the internal message queue.
Syntax
public void doEvents();
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 (Retail Class)
Used when authorization cannot be obtained online.
Syntax
public void force(String 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 throws an exception.
GetResponseVar Method (Retail Class)
Parses additional information out of the response.
Syntax
public String getResponseVar(String 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 fields. Any additional response information contained within the Data may be retrieved with this GetResponseVar method. There are three formats for the Data returned by the gateways this class supports: Name/value pairs, delimited list, or XML. The value you pass in the Name parameter changes based on these formats, as detailed below:
If the Data field contains name/value pairs, pass the name in the Name parameter and this method will return the value. For instance, if Data contains "ResponseCode=00&FraudScore=53&ApprovalCode=123456&...", calling GetResponseVar("FraudScore") will return "53".
However, if Data contains a delimited list, pass the index of the field you wish to receive. For instance, if Data contains "00|53|123456|...", calling GetResponseVar("1") will return "53".
Finally, if Data contains XML, pass the xpath to the value you wish to receive. For instance, if Data contains "<Response><Code>00</Code><FraudScore>53</FraudScore><ApprovalCode>123456</ApprovalCode></Response>", calling GetResponseVar("/Response/FraudScore") will return "53".
Interrupt Method (Retail Class)
Interrupts the current action.
Syntax
public void interrupt();
Remarks
This method interrupts any processing that the class is currently executing.
Refund Method (Retail Class)
Refunds a previously captured transaction.
Syntax
public void refund(String transactionId, String 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 TransactionId 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 InvoiceNumber rather than the TransactionId.
Reset Method (Retail Class)
Clears all properties to their default values.
Syntax
public void reset();
Remarks
This method clears all properties to their default values and returns the component to its default state.
ResetSpecialFields Method (Retail Class)
Resets all special fields to the default settings.
Syntax
public void resetSpecialFields();
Remarks
This function resets all special gateway configuration fields to the default settings for the specified Gateway.
Please refer to the SpecialFields property for more information on form variables and how they are managed.
Sale Method (Retail Class)
Initiates an Sale transaction (authorization and capture).
Syntax
public void sale();
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 (Retail Class)
Voids a previously authorized transaction.
Syntax
public void voidTransaction(String 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 TransactionId 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 InvoiceNumber rather than the TransactionId.
For the PSIGateXML gateway, send the TransactionId 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 (Retail Class)
Information about errors during data delivery.
Syntax
public class DefaultRetailEventListener implements RetailEventListener { ... public void error(RetailErrorEvent e) {} ... } public class RetailErrorEvent { public int errorCode; public String 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 (Retail Class)
Fired after the server presents its certificate to the client.
Syntax
public class DefaultRetailEventListener implements RetailEventListener { ... public void SSLServerAuthentication(RetailSSLServerAuthenticationEvent e) {} ... } public class RetailSSLServerAuthenticationEvent { public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; //read-write }
Remarks
During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.
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 (Retail Class)
Fired when secure connection progress messages are available.
Syntax
public class DefaultRetailEventListener implements RetailEventListener { ... public void SSLStatus(RetailSSLStatusEvent e) {} ... } public class RetailSSLStatusEvent { public String message; }
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
CCCard Type
Contains the customer's credit card information.
Remarks
This type contains the customer's credit card information. If you are processing transactions where the customer and his credit card are physically present, set the MagneticStripe field with the data read from the card reader. You may set either Track1 or Track2 data (but not both). You must also set the EntryDataSource to indicate which track is stored in the MagneticStripe field.
Example: Setting the Fields
CCCard card = new CCCard();
card.MagneticStripe = "B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A";
card.EntryDataSource = edsTrack1;
Example: Using a Constructor
CCCard card = new CCCard("B4012000033330026^FDMS TEST CARD /VISA^090410054321000000000000000 150 A", edsTrack1);
If you are processing a transaction where the credit card is not physically present (eCommerce, mail/order, etc) or if the magstripe on the back of the card cannot be read by the card reader, you must set the Number, ExpMonth, and ExpYear fields, and EntryDataSource must be set to one of the manually entered enumerations.
Example: Setting the Fields
CCCard card = new CCCard();
card.Number = "4788250000028291";
card.ExpMonth = 12;
card.ExpYear = 2010;
card.EntryDataSource = edsManualEntryNoCardReader;
Example: Using a Constructor
CCCard card = new CCCard("4012000033330026", 04, 2009);
Note that the constructor in the previous example automatically sets the EntryDataSource to edsManualEntryNoCardReader. If you wish to set any
other value for the EntryDataSource, you must set it yourself before authorizing the transaction.
When authorizing a transaction, the fields used by the class are solely dependant on the value of EntryDataSource. If you set the Number, ExpMonth, and ExpYear fields, but EntryDataSource is set to edsTrack2, the class will look for MagneticStripe data when authorizing the transaction, and will throws an exception because none is present.
Fields
CardType
int
Default Value: 0
Type of credit card being used in this transaction. This field contains the customer's credit card type. This is automatically computed after the Number is set, but it can also be changed manually. A list of valid card types is included below.
ctUnknown (0) | Invalid or unknown prefix, card type not known. |
ctVisa (1) | Visa or Delta Card. |
ctMasterCard (2) | MasterCard. |
ctAMEX (3) | American Express Card. |
ctDiscover (4) | Discover Card. |
ctDiners (5) | Diners Club or Carte Blanche Card. |
ctJCB (6) | JCB Card. |
ctVisaElectron (7) | Visa Electron Card (runs as a Visa for most gateways) |
ctMaestro (8) | Maestro Card |
ctLaser (10) | Laser Card (Ireland) |
CVVData
String
Default Value: ""
Three digit security code on back of card (optional).
This alphanumeric field contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional field which can be used to determine if the customer is actually in possession of the credit card.
Even if the CVVData is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult field and decide whether to honor the transaction or not.
Note: When set to a non-empty value, CVVPresence will be automatically set to cvpProvided. If set to empty string (""), CVVPresence will be automatically set to cvpNotProvided.
CVVPresence
int
Default Value: 0
Indicates the presence of the card verification value.
This field is used to indicate the presence of CVVData.
The class will automatically set this value to cvpProvided when a CVVData value is specified. You can explicitly specify the CVVPresence indicator by setting this property.
Available values are:
- cvpNotProvided (0)
- cvpProvided (1)
- cvpIllegible (2)
- cvpNotOnCard (3)
EntryDataSource
int
Default Value: 0
This field contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this field.
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). |
ExpMonth
int
Default Value: 1
Expiration month of the credit card specified in Number.
This field contains the expiration date of the customer's credit card, and must be in the range 1 - 12.
ExpYear
int
Default Value: 2000
Expiration year of the credit card specified in Number.
This field contains the expiration date of the customer's credit card. This field must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.
IsEncrypted
boolean
Default Value: False
Determines whether data set to the Number or MagneticStripe fields is validated.
By default, when the Number or MagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and MagneticStripe data will be parsed for the track specified by EntryDataSource. 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 Number or MagneticStripe 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.
MagneticStripe
String
Default Value: ""
Track data read off of the card's magnetic stripe.
If EntryDataSource is not one of the manually entered enumerations, then this field 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 field with track 1 or track 2 data, and may not pass both. Use the EntryDataSource field to indicate which track you are sending.
The following example shows how to set the MagneticStripe and EntryDataSource fields if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"
class.Card = new CCCard("B4788250000028291^TSYS^05121015432112345678", dsTrack1)
or
class.Card = new CCCard("4788250000028291=05121015432112345678", dsTrack2)
or
CCCardType Card = new CCCard()
Card.MagneticStripe = "B4788250000028291^TSYS^05121015432112345678"
Card.EntryDataSource = dsTrack1
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.
Number
String
Default Value: ""
Customer's credit card number for the transaction.
If you're sending the transaction with MagneticStripe data, this field should be left empty.
Constructors
public CCCard();
public CCCard( number, expMonth, expYear);
public CCCard( magneticStripe, entryDataSource);
Certificate Type
This is the digital certificate being used.
Remarks
This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.
- EffectiveDate
- ExpirationDate
- ExtendedKeyUsage
- Fingerprint
- FingerprintSHA1
- FingerprintSHA256
- Issuer
- KeyPassword
- PrivateKey
- PrivateKeyAvailable
- PrivateKeyContainer
- PublicKey
- PublicKeyAlgorithm
- PublicKeyLength
- SerialNumber
- SignatureAlgorithm
- Store
- StorePassword
- StoreType
- SubjectAltNames
- ThumbprintMD5
- ThumbprintSHA1
- ThumbprintSHA256
- Usage
- UsageFlags
- Version
- Subject
- Encoded
Fields
EffectiveDate
String (read-only)
Default Value: ""
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
ExpirationDate
String (read-only)
Default Value: ""
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
ExtendedKeyUsage
String (read-only)
Default Value: ""
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
Fingerprint
String (read-only)
Default Value: ""
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
FingerprintSHA1
String (read-only)
Default Value: ""
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
FingerprintSHA256
String (read-only)
Default Value: ""
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
Issuer
String (read-only)
Default Value: ""
The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.
KeyPassword
String
Default Value: ""
The password for the certificate's private key (if any).
Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. This field can be used to read such password-protected private keys.
Note: This property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.
PrivateKey
String (read-only)
Default Value: ""
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.
PrivateKeyAvailable
boolean (read-only)
Default Value: False
Whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
PrivateKeyContainer
String (read-only)
Default Value: ""
The name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
PublicKey
String (read-only)
Default Value: ""
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
PublicKeyAlgorithm
String (read-only)
Default Value: ""
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
PublicKeyLength
int (read-only)
Default Value: 0
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
SerialNumber
String (read-only)
Default Value: ""
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
SignatureAlgorithm
String (read-only)
Default Value: ""
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
Store
String
Default Value: "MY"
The name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StoreB
byte[]
Default Value: "MY"
The name of the certificate store for the client certificate.
The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.
Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
StorePassword
String
Default Value: ""
If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store.
StoreType
int
Default Value: 0
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 field 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 (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 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 PKCS#11 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 PKCS#11 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 Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
SubjectAltNames
String (read-only)
Default Value: ""
Comma-separated lists of alternative subject names for the certificate.
ThumbprintMD5
String (read-only)
Default Value: ""
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA1
String (read-only)
Default Value: ""
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
ThumbprintSHA256
String (read-only)
Default Value: ""
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
Usage
String (read-only)
Default Value: ""
The text description of UsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
UsageFlags
int (read-only)
Default Value: 0
The flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the Usage field for a text representation of UsageFlags.
This functionality currently is not available when the provider is OpenSSL.
Version
String (read-only)
Default Value: ""
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
Subject
String
Default Value: ""
The subject of the certificate used for client authentication.
This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.
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 as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Encoded
String
Default Value: ""
The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
EncodedB
byte[]
Default Value: ""
The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.
When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.
Constructors
public Certificate();
Creates a instance whose properties can be set. This is useful for use with when generating new certificates.
public Certificate( certificateFile);
Opens CertificateFile and reads out the contents as an X.509 public key.
public Certificate( encoded);
Parses Encoded as an X.509 public key.
public Certificate( storeType, store, storePassword, subject);
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.
After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate( storeType, store, storePassword, subject, configurationString);
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.
ConfigurationString is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the cstUser , cstMachine , cstPublicKeyFile , and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.
After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate( storeType, store, storePassword, encoded);
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.
After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
public Certificate( storeType, store, storePassword, subject);
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate( storeType, store, storePassword, subject, configurationString);
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.
public Certificate( storeType, store, storePassword, encoded);
StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.
After the store has been successfully opened, the class will load Encoded as an X.509 certificate and search the opened store for a corresponding private key.
EPCustomer Type
Contains customer information.
Remarks
This type contains information about the customer which the merchant has collected. At the minimum, this should include the customer's name and address. You may also optionally include a merchant-generated customer Id, the customer's Email address, Phone number, and Fax number. This type is used by both the ICharge and ECheck classs.
Example:
EPCustomer cust = new EPCustomer();
cust.FirstName = "John"
cust.LastName = "Smith"
cust.FullName = "John M. Smith"
cust.Address = "123 Nowhere Ln."
cust.City = "Beverly Hills"
cust.State = "CA"
cust.Zip = "90210"
cust.Country = "USA"
cust.Phone = "555-555-5555"
cust.Email = "jsmith@fake.com"
cust.Id = "123456"
ICharge1.Customer = cust;
Fields
Address
String
Default Value: ""
Customer's street address. This field 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 field. City, state, and zip code are set in the City, State, and Zip fields.
The length of this field varies by gateway. If the customer's address is very long, it is admissible to include only the street number in This field.
NOTE: For the Moneris gateway, this field should contain only the customer's street number. The street name should be added via the AddSpecialField method. For example:
class.Customer = new EPCustomer();
class.Customer.Address = "123";
class.AddSpecialField("avs_street_name, "Nowhere Ln");
Address2
String
Default Value: ""
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).
Aggregate
String
Default Value: ""
This field allows you to get or set an XML aggregate built from all of the fields from this type.
"EPCustomer" is the root element, and the names of the fields create the tags under the root.
For instance:
<EPCustomer>
<Address>123 Nowhere Ln.</Address>
<Address2>Apt 3B.</Address2>
<City>Beverly Hills</City>
...
</EPCustomer>
City
String
Default Value: ""
Customer's city. This field 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 fields include Address, State, and Zip.
Country
String
Default Value: ""
Customer's country. This field 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 field with the PayFuse gateway, this field should contain the ISO-3166 numeric code instead of the standard two-letter code. For example, the ISO code for the US is "840".
Email
String
Default Value: ""
Customer's email address. This optional field contains the customer's email address.
Fax
String
Default Value: ""
Customer's fax number. This optional field contains the customer's fax number.
FirstName
String
Default Value: ""
Customer's first name. This field contains the customer's first name.
FullName
String
Default Value: ""
Customer's full name. This field contains the customer's full name as it appears on the credit card or bank account. Many gateways use this field in addition to, or instead of, the FirstName and LastName fields. If a gateway requires a FullName and the field is empty, FullName will be constructed using the contents of FirstName and LastName.
Id
String
Default Value: ""
Merchant-generated customer Id. This field contains a merchant-generated customer identification number. This number should be unique for each different customer that places an order with the merchant.
LastName
String
Default Value: ""
Customer's last name. This field contains the customer's last name as it appears on their credit card.
Phone
String
Default Value: ""
Customer's phone number. This optional field contains the customer's phone number.
State
String
Default Value: ""
Customer's state. This field 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 fields include Address, City, and Zip.
Zip
String
Default Value: ""
Customer's zip code (or postal code if outside of the USA). This field 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 fields include Address, City, and State.
Constructors
public EPCustomer();
EPResponse Type
Contains the response to the authorization.
Remarks
This type contains the results of a transaction made with the ICharge, Retail, and ECheck classs. The fields contained by this type are listed below.
- ApprovalCode
- Approved
- ApprovedAmount
- AVSResult
- Code
- CVVResult
- Data
- ErrorCode
- ErrorText
- InvoiceNumber
- ProcessorCode
- Text
- TransactionId
Fields
ApprovalCode
String (read-only)
Default Value: ""
Contains an authorization code when a transaction has been approved. This field contains an authorization code when a transaction has been approved. If the Code returned indicates that the transaction is not approved, then the contents of this field should be ignored.
Approved
boolean (read-only)
Default Value: False
Indicates the status of the last transaction. This field 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 Code should be inspected and evaluated according to the specifications of the Gateway in use. A list of response codes for each gateway is listed in the table of contents. However, it is recommended that the developer acquire the current list from the Gateway which is being used.
ApprovedAmount
String (read-only)
Default Value: ""
The amount approved for the transaction, this is the amount actually charged to the credit card.
This field is primarily used when gateways allow partial authorizations and AllowPartialAuths is 'True'. Thus this field 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 field is not populated).
AVSResult
String (read-only)
Default Value: ""
Contains the Address Verification System result code. This one character field 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).
AVSResult | Description |
A | Address matches, Zip does not. |
E | AVS error. |
G | Non-U.S. issuing bank does not support AVS. |
N | No match on Address or CustomerZip. |
P | AVS not applicable for this transaction. |
R | Retry - Issuer system unavailable. |
S | Service not supported by issuer. |
U | Address information is unavailable. |
W | Nine digit Zip matches, Address does not. |
X | Exact AVS match, nine digit Zip. |
Y | Exact AVS match, five digit Zip. |
Z | Five digit Zip matches, Address does not. |
Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.
Adyen
For Adyen, this field will contain the following possible values:
0 | Unknown |
1 | Address matches, postal code doesn't |
2 | Neither postal code nor address match |
3 | AVS unavailable |
4 | AVS not supported for this card type |
5 | No AVS data provided |
6 | Postal code matches, address doesn't match |
7 | Both postal code and address match |
8 | Address not checked, postal code unknown |
9 | Address matches, postal code unknown |
10 | Address doesn't match, postal code unknown |
11 | Postal code not checked, address unknown |
12 | Address matches, postal code not checked |
13 | Address doesn't match, postal code not checked |
14 | Postal code matches, address unknown |
15 | Postal code matches, address not checked |
16 | Postal code doesn't match, address unknown |
17 | Postal code doesn't match, address not checked |
18 | Neither postal code nor address were checked |
American Payment Solutions
For American Payment Solutions, this field will contain the following possible values:
X | Exact match, 9-character numeric ZIP |
Y, D, or M | Exact match, 5-character numeric ZIP |
2 or 6 | Exact match, 5-character numeric ZIP, customer name |
A or B | Address match only |
3 or 7 | Address, customer name match only |
W | 9-character numeric ZIP match only |
Z, P, or L | 5-character ZIP match only |
1 or 5 | 5-character ZIP, customer name match only |
N or C | No address or ZIP match only |
4 or 8 | No address or ZIP or customer name match only |
U | Address unavailable |
G or I | Non-U.S. issuer does not participate |
R | Issuer system unavailable |
E | Not a mail/phone order |
S | Service not supported |
0, O, or B | AVS not available |
Barclay
For Barclay, the field will contain the following possible values:
YY | Address and zip code or postal code match |
YN | Address matches only |
NY | Zip code or postal code matches |
NN | Neither address nor zip code or postal code matches; address is not parsable |
UU | Address information is unavailable, service is unavailable, or Error; Unknown |
Blank | No AVS performed |
BlueSnap
For BlueSnap, the field will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following fields:
1st Character | Name AVS check |
2nd Character | Address AVS check |
3rd Character | Postal/Zip Code AVS check |
The possible values for each result character are:
M | Matches |
N | Does not match |
U | Could not be verified |
HSBC
For HSBC, the field will contain the following possible values:
YY | Address and zip code or postal code match |
YN | Address matches only |
NY | Zip code or postal code matches |
NN | Neither address nor zip code or postal code matches; address is not parsable |
UU | Address information is unavailable, service is unavailable, or Error; Unknown |
FF | Issuer does not participate in AVS |
Blank | No AVS performed |
PayTrace / PayTraceJSON
For PayTrace / PayTraceJSON, the field 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 AVSResult field 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 AVSResult of "Fail,Pass" means that the street address failed validation, but the zip code passed.
DataCash
For DataCash, the field 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 field 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 field will contain a 4-character string, which contains the AVS checks for the following fields:
1st Character | Card Verification Value (CVV) check |
2nd Character | Postal/Zip Code AVS check |
3rd Character | Address AVS check |
4th Character | Country Comparison check |
The possible values for each result character are:
0 | Not Supported. |
1 | Not Checked. |
2 | Matched. |
4 | No Match. |
8 | Partial Match. |
Worldpay Online
For Worldpay Online, the field will contain one of the following:
Value | Description |
APPROVED | The supplied street and postal code details fully matched the payment provider's records |
PARTIAL APPROVED | One of the supplied street or postal code details did not match the payment provider's records |
NOT SENT TO ACQUIRER | Problem with acquirer - possibly no AVS support |
NO RESPONSE FROM ACQUIRER | Problem with acquirer - possibly no AVS support |
NOT CHECKED BY ACQUIRER | The acquirer did not check the address details |
NOT SUPPLIED BY SHOPPER | Missing, incomplete or invalid address details in the order prevented the address from being checked |
FAILED | Both street and postal code details did not match the payment provider's records |
Code
String (read-only)
Default Value: ""
Indicates the status of the authorization request. This field contains the actual response code as returned by the Gateway. Unlike the Approved field, this Code field may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the Code as well as the Approved field. The Point of Sale system should evaluate this response code and NOT the Text to determine nature of a response message. The current (at the time of this release) response codes for the supported Gateways are listed in the table of contents to your left.
CVVResult
String (read-only)
Default Value: ""
Contains the returned CVV2 result code if it was requested. This field contains the host returned CVV2 result code (if CVV data was sent in the request). The following is a list of current result codes:
M | CVV2 Match. |
N | CVV2 No Match. |
P | Not Processed. |
S | Merchant has indicated that CVV2 is not present on card. |
U | Issuer not certified and/or has not provided Visa encryption keys. |
Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.
HSBC
For HSBC, the field will contain:
0 | Card type does not support CVM |
1 | CVM match |
2 | CVM did not match issuer value |
3 | CVM was not processed |
4 | CVM should be on the card but cardholder indicated otherwise |
5 | CVM not supported by issuer |
6 | Not valid |
7 | No response from server |
Adyen
For Adyen, the field will contain:
0 | Unknown |
1 | Matches |
2 | Does not match |
3 | Not checked |
4 | No CVC/CVV provided, but was required |
5 | Issuer not certified for CVC/CVV |
6 | No CVC/CVV provided |
Barclay
For Barclay, the field will contain:
0,1 | CVM was not processed |
2 | CVM match |
4 | CVM does not match issuer value |
Unknown | CVM invalid or missing |
Blank | No response from server |
BlueSnap
For BlueSnap, the field will contain:
MA | Match |
NC | Issuer is not certified for CVV2/CVC2/CID |
ND | Check was not done |
NM | No match |
NP | CVV2/CVC2/CID should be on the card but is not present |
NR | CVV check not requested |
DataCash
For DataCash, the field 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 field 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 field will contain one of the following:
Value | Description |
APPROVED | The supplied CVC details matched the payment provider's records |
NOT SENT TO ACQUIRER | Problem with acquirer - possibly no CVC support |
NO RESPONSE FROM ACQUIRER | Problem with acquirer - possibly no CVC support |
NOT CHECKED BY ACQUIRER | The acquirer did not check the CVC details |
NOT SUPPLIED BY SHOPPER | Missing, or invalid CVC in the payment details prevented the CVC from being checked |
FAILED | The supplied CVC did not match the payment provider's records |
Data
String (read-only)
Default Value: ""
The entire response returned from the gateway processor. This field 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 fields.
ErrorCode
String (read-only)
Default Value: ""
Additional error code returned by some gateways. If a gateway returns it, this field will contain an additional code that may explain why the transaction was declined. You may also wish to inspect ErrorText for a human-readable description of this ErrorCode.
ErrorText
String (read-only)
Default Value: ""
Additional error description returned by some gateways. If a gateway returns it, this field will contain a human-readable description of the error which occurred (if any). You may also wish to inspect ErrorCode for an accompanying code which may be parsed and used by your application.
InvoiceNumber
String (read-only)
Default Value: ""
Invoice number submitted in authorization request (if applicable). This field contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.
ProcessorCode
String (read-only)
Default Value: ""
Response code from the underlying processor. Often times a Gateway will return a Code that indicates only whether the transaction is approved or declined. Many of these also include a secondary code that provides more details as to why the transaction was declined.
Note, for the PayFlowPro Gateway this field 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.
Text
String (read-only)
Default Value: ""
Text information that describes each response code. This field 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).
TransactionId
String (read-only)
Default Value: ""
Contains the Visa Transaction Identifier or MasterCard Reference Number. This field 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 field. Data returned in this field (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).
Constructors
public EPResponse();
EPShipInfo Type
Contains shipping information.
Remarks
This type contains the shipping information which the merchant has collected. Shipping information is typically optional data. This type is used by the ICharge classs.
Example:
EPShipInfo shipInfo = new EPShipInfo();
shipInfo.FirstName = "John"
shipInfo.LastName = "Smith"
shipInfo.Address = "123 Nowhere Ln."
shipInfo.City = "Beverly Hills"
shipInfo.State = "CA"
shipInfo.Zip = "90210"
shipInfo.Country = "USA"
shipInfo.Phone = "555-555-5555"
ICharge1.ShippingInfo = shipInfo;
Fields
Address
String
Default Value: ""
Customer's shipping street address.
Address2
String
Default Value: ""
A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).
City
String
Default Value: ""
Customer's shipping city.
Country
String
Default Value: ""
Customer's shipping country. This field contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.
Email
String
Default Value: ""
Customer's email address.
FirstName
String
Default Value: ""
Customer's first name.
LastName
String
Default Value: ""
Customer's last name.
Phone
String
Default Value: ""
Customer's phone number.
State
String
Default Value: ""
Customer's shipping state.
Zip
String
Default Value: ""
Customer's shipping zip code (or postal code if outside of the USA).
Constructors
public EPShipInfo();
EPSpecialField Type
Additional name/value pairs which can be added to a transaction.
Remarks
This type contains a Name and Value which may contain any additional information you wish to send to your gateway that this class does not currently send. You must know the field name in the gateway integration guide available from your gateway. For instance, the code below shows how to add a customer IP Address for the Authorize.Net gateway:
ICharge1.SpecialFields.add(new EPSpecialField("x_customer_ip", "255.123.456.78"));
Fields
Name
String
Default Value: ""
Name of special configuration field to submit in this transaction. The Name and Value fields can be used to send special gateway configuration and transaction fields for each transaction. These fields can also be used to extend the functionality of this class by submitting additional information to the gateway.
This field is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.
Value
String
Default Value: ""
Value of special configuration field to submit in this transaction. The Name and Value fields can be used to send special gateway configuration and transaction fields for each transaction. These fields can also be used to extend the functionality of this class by submitting additional information to the gateway.
Note: This field is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.
Constructors
public EPSpecialField();
public EPSpecialField( name, value);
Proxy Type
The proxy the class will connect to.
Remarks
When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.
Fields
AuthScheme
int
Default Value: 0
The type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.
AuthScheme should be set to authNone (3) when no authentication is expected.
By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the class will attempt basic authentication.
If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If AuthScheme 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 AuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this field will clear the values of User and Password.
AutoDetect
boolean
Default Value: False
Whether to automatically detect and use proxy system settings, if available. The default value is false.
Note: This setting is applicable only in Windows.
Password
String
Default Value: ""
A password if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Port
int
Default Value: 80
The Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server field for details.
Server
String
Default Value: ""
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the Server field is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.
SSL
int
Default Value: 0
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. |
User
String
Default Value: ""
A username if authentication is to be used for the proxy.
If AuthScheme is set to Basic Authentication, the User and Password fields are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.
If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.
Constructors
public Proxy();
public Proxy( server, port);
public Proxy( server, port, user, password);
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
Y | The customer was successfully authenticated. |
N | The customer failed authentication, and the transaction is denied. |
U | Authentication could not be performed due to technical or other problems. |
A | Authentication was not available, but functionality was available (through the issuer, Visa, or a third party) to generate a proof of authentication attempt. |
Value | Format |
0 | Unspecified (default) |
1 | Dollars (1.00) |
2 | Cents (100) |
This setting is applicable to the following gateways:
- Authorize.NET (gwAuthorizeNet)
- BlueSnap (gwBlueSnap)
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.
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) |
This config is currently applicable to the Heartland gateway.
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) |
For more information on these currency code values, please refer to the ISO 4217 standard as well as the gateway specification.
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)
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)
The following gateways currently support this functionality: Heartland.
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 |
Applicable values are:
Value | Description |
1 | No wallet provider |
2 | Visa Checkout |
3 | MasterPass |
4 | Apple Pay |
5 | Samsung Pay |
6 | Android Pay |
Value | Algorithm |
0 | MD5 (default) |
1 | SHA-1 |
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, TransactionId, 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 throws an exception. 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.
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. |
icharge.Config("LitleAdvancedFraudChecksId=ASDFG-AXXXXAB999");
icharge.AddSpecialField("CustomAttribute1", "One");
icharge.AddSpecialField("CustomAttribute2", "Two");
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. |
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>
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).
Valid Values:
Value | Description |
1 | Magtek Udynamo |
2 | Magtek IPAD |
3 | All IDTech Devices |
4 | Specific Ingenico Devices |
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. |
- CCCOMPLETE
- CCADDINSTALL
- CCADDRECURRING
- CCINSTALLSALE
- CCRECURRINGSALE
"A" | Auto Generate the CustomerRefNum (Id) |
"S" | Use CustomerRefNum (Id) sent in the request. |
"0" | Use OrderID (InvoiceNumber) sent in the request. |
"D" | Use Comments (TransactionDesc) sent in the request. |
"NO" | No mapping to order data. |
"OI" | Pre-populate OrderId (InvoiceNumber) with the Customer Reference Number (Id). |
"OD" | Pre-populate the Comments field (TransactionDesc) with the Customer Reference Number (Id). |
"OA" | Pre-populate the OrderId (InvoiceNumber) and Comments (TransactionDesc) fields with the Customer Reference Number (Id). |
ICharge.Config("PayFlowProToken=" + ICharge.Response.TransactionId);
ICharge.TransactionId = "2";
ICharge.TransactionAmount = "10.00";
ICharge.Sale();
ICharge.Config("PayTraceAddPurchaseCardData=123456789");
Note that this is only valid when calling Sale or AuthOnly methods and the Gateway property is set to gwPayTraceJSON (117)
Note that this is only valid when calling Sale or AuthOnly methods and the Gateway property is set to gwPayTraceJSON (117)
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
icharge.Config("PKPaymentToken={\"version\":\"EC_v1\",\"data\":\"...\",\"signature\":\"...\",\"header\":{\"applicationData\":\"...\",\"transactionId\":\"...\",\"ephemeralPublicKey\":\"...\",\"publicKeyHash\":\"...\"}}");
PKPaymentToken is currently only supported in gwLitle.
component.Sale()
MyString = component.Config("RawRequest")
component.Sale()
MyString = component.Config("RawResponse")
"RelatedSecurityKey" and "RelatedVendorTXCode" special fields are required for Repeats. These are parsed out of the original authorization response.
The TransactionId 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 | ApprovalCode from original transaction response. |
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 EntryDataSource.):
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.
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 |
The current element is specified via the XPath configuration option.
This configuration option is read-only.
The current element is specified via the XPath configuration option.
This configuration option is read-only.
The current element is specified via the XPath configuration option.
This configuration option is read-only.
This configuration option is read-only.
'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 |
Example (Setting XPath for XML)
Document root | Charge.XPath = "/" |
Specific Element | Charge.XPath = "/root/SubElement1/SubElement2/" |
i-th Child | Charge.XPath = "/root/SubElement1[i]" |
Document root | Charge.XPath = "/" |
Specific Element | Charge.XPath = "/root/SubElement1/SubElement2/" |
i-th Child | Charge.XPath = "/root/SubElement1/[i]" |
This configuration option is read-only.
HTTP Config Settings
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.
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 throws an exception if the server does not support HTTP/2.
The default value is True.
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]".
The default value is False.
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 throws an exception.
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 throws an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0") or HTTP/3 ("3.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/2 is supported on all platforms. The class will use the internal security implementation in all cases when connecting.
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.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
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).
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
To save all items to the collection, set this configuration setting to -1. If no items are wanted, set this to 0, which will not save any items to the collection. The default for this configuration setting is -1, so all items will be included in the collection.
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.
.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"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
The default value is False and the hostname will always be used exactly as specified.
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.
Override the default with the name and version of your software.
TCPClient Config Settings
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.
If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case.
RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event.
The connection to the firewall is made by calling the Connect method.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.
0 | No firewall (default setting). |
1 | Connect through a tunneling proxy. FirewallPort is set to 80. |
2 | Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. |
3 | Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. |
10 | Connect through a SOCKS4A Proxy. FirewallPort is set to 1080. |
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This setting is provided for use by classs that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
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.
In multihomed 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 multihomed hosts (machines with more than one IP interface).
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 configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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 configuration setting has no effect if SSLProvider is set to Platform.
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.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
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 it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
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 it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration 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 configuration 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 configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
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.
Note: This value must be set after SSLProvider is set.
Example values:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA");
obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA");
Possible values when SSLProvider is set to Platform include the following:
- SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_RC4_128_SHA
- SSL_RSA_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_WITH_DES_CBC_SHA
- SSL_RSA_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_RC4_40_MD5
- SSL_DHE_DSS_WITH_DES_CBC_SHA
- SSL_RSA_WITH_NULL_MD5
- SSL_DH_anon_WITH_3DES_EDE_CBC_SHA
- SSL_DHE_RSA_WITH_DES_CBC_SHA
- SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA
- SSL_RSA_WITH_NULL_SHA
- SSL_DH_anon_WITH_RC4_128_MD5
- SSL_RSA_WITH_RC4_128_MD5
- SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- SSL_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_NULL_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended)
- TLS_ECDH_anon_WITH_RC4_128_SHA
- TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended)
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_EXPORT_WITH_RC4_40_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_RC4_128_SHA
- TLS_ECDH_ECDSA_WITH_RC4_128_SHA
- TLS_ECDH_anon_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_RSA_WITH_NULL_SHA256
- TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA
- TLS_KRB5_WITH_RC4_128_MD5
- TLS_ECDHE_ECDSA_WITH_NULL_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_RC4_128_SHA
- TLS_EMPTY_RENEGOTIATION_INFO_SCSV
- TLS_KRB5_WITH_3DES_EDE_CBC_MD5
- TLS_KRB5_WITH_RC4_128_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_NULL_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_WITH_DES_CBC_MD5
- TLS_KRB5_EXPORT_WITH_RC4_40_MD5
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5
- TLS_ECDH_anon_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_KRB5_WITH_DES_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_NULL_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
Possible values when SSLProvider is set to Internal include the following:
- 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_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.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (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 that 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 supported only 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 available only 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, these 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.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
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.
Note: When SSLProvider is set to Internal this value is automatically set to true. This is needed for proper validation when using the internal provider.
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 traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class throws an exception.
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 configuration 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.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
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)
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 configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only 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"
- "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 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
Note: This option is not valid for User Datagram Protocol (UDP) ports.
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.
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
In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the class does not attempt to process external events.
- 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.
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.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
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. |
HTTP Errors
118 | Firewall error. The error description contains the 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 | Cannot open AttachedFile. |
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. |
303 | 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 nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot 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] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is 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 is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |