4D Payments SDK 2016 .NET Edition

Questions / Feedback?

PTechECommerce Component

Properties   Methods   Events   Configuration Settings   Errors  

The PTECHECOMMERCE component is an advanced tool used to authorize credit card transactions in both Direct Marketing and E-Commerce environments with the Paymentech NetConnect system on the Tampa platform. It allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.




Setting up the component and authorizing a transaction is easy. First, set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service. You should also set your IndustryType to either Direct Marketing (mail order/telephone order) or E-Commerce at this time.

After the merchant information is setup, you may enter transaction data. The Credit Card's EntryDataSource must be Manually Entered for this component, so the Number, ExpMonth, and ExpYear fields should be filled out and the MagneticStripe left empty. Address Verification Service (AVS) data may be sent by filling the CustomerAddress and CustomerZip properties. In addition, the TransactionAmount should be set with the total amount for the transaction, including any taxes.

Now simply call the Sale or AuthOnly method to send the authorization to the Paymentech Server.

The result of the authorization request will be stored in the Response property. The Code field will contain the status of the request and the Text field will contain the human-readable response message. The contents of the Response should be logged after a successful transaction.

Once an authorization request is approved, one of three things happen. If you are using the Host Capture SettlementMode, and your Paymentech account is setup with the Host Auto Close feature, you need take no further action. The host will close the current open batch at a designated time each day. This means that there is no end of day batch processing required from the merchant. In order for the merchant's batch to be included in the Paymentech Host Auto Close process, the merchant parameter file on the host must indicate that the merchant is Auto Close. Without this flag being set, the merchant's transactions must be settled with a Manual Batch Release.

If you are using the Host Capture SettlementMode, and your Paymentech account not setup with Host Auto Close, then after an authorization is approved the transaction is added to the current batch on the Paymentech Server, and the money in the customer's account is blocked and tagged for the merchant. The transaction must go through the Manual Batch Release Settlement process in order for the blocked money to be transferred to the merchant's account. To release a batch for settlement, please see the PTechHostSettle component.

If you are using the Terminal Capture SettlementMode, you must store the XML aggregate returned from the GetDetailAggregate method and submit it at the end of the day in a manual batch settlement. A detail aggregate for each authorized transaction must be sent in a batch using the PTechManualSettle component. A transaction that has been authorized and then subsequently voided with this component must NOT be added to the batch settlement, and must not be submitted with the PTechManualSettle component. Any transaction not submitted with PTechManualSettle will eventually time out, and the block on the customer's card will be removed (essentially, you may void transactions by simply not sending them in the batch settlement). The Terminal Capture SettlementMode is required for the Restaurant and Hotel IndustryTypes. This is because both IndustryTypes will generally have additional charges added on to the original authorization (for example: a tip for your server, or a drink from the hotel bar charged to your room). Other IndustryTypes may benefit from this functionality as well, but if you do not require your transactions to be authorized for one amount and then settled for a different amount, it is highly recommended you use the much simpler Host Capture SettlementMode.

Note that a transaction authorized in the Host Capture SettlementMode MUST be released for settlement using the PTechHostSettle component. It cannot be added to a manual batch settlement using the PTechManualSettle component. Doing so will result in charging the customer twice! Likewise, transactions authorized with SettlementMode set to Terminal Capture cannot be released using the PTechHostSettle component, because no record of the transaction has been stored on the Paymentech Server.

Also note that you cannot mix Host Capture and Terminal Capture SettlementModes on the same MerchantNumber / TerminalNumber pair. Contact Paymentech to setup your merchant account for Terminal Capture.

Property List

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

CardContains the customer's credit card information.
CAVVAuthenticationCAVV data from a ThreeDSecure authentication.
ClientNumberMerchant configuration property, assigned by Paymentech.
CustomerAddressThe customer's billing address.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
DuplicateCheckingIndicates whether duplicate checking is enabled.
ECIElectronic Commerce Indicator.
GoodsIndicatorIndicates the type of goods being sold by an e-Commerce merchant.
IndustryTypeDetermines the merchant's industry type.
InvoiceNumberMerchant-generated invoice number.
Level2DataSupplies extra information for Commercial or Purchasing cards.
MerchantNumberA unique number used to identify the merchant, assigned by Paymentech.
PasswordPassword for authentication with the NetConnect Server .
PinlessDebitIndicates whether the transaction will be a Pinless Debit transaction.
POSRetrievalNumberMerchant-generated reference number, used for reversals.
ProxyA set of properties related to proxy access.
ResponseContains the response to an authorization.
SequenceNumberSequence number of the transaction.
ServerThe URL for the PaymenTech NetConnect server.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TAVVVisa/ChaseNet Token Authentication Verification Value to support 3-D Secure (3DS) validation.
TerminalNumberTerminal number assigned by Paymentech.
TimeoutA timeout for the component.
TransactionAmountPurchase amount for an authorization.
UserIdUserId for authentication with the NetConnect Server .
XIDTransactionId from a 3D Secure authentication.

Method List

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

AuthOnlySends an AuthOnly transaction to the host.
CaptureSends a capture transaction to the PaymenTech Server.
ConfigSets or retrieves a configuration setting.
CreditCredits a cardholder's account or obtains a Return Authorization.
GetDetailAggregateReturns an aggregate containing details of this transaction, which is then used for manual settlement.
InterruptInterrupt the current method.
ResetClears all properties to their default values.
SaleSends a Sale transaction to the host.
VoidTransactionVoids a transaction in the current batch.

Event List

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

DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

AllowPartialAuthsIndicates whether partial authorizations are to be supported.
CustomerDefinedDataAdditional transaction identification data.
DigitalPaymentCryptogramConsumer Digital Payment Cryptogram associated with CDPT token transactions (Mastercard only).
DirectoryServerTxnIDDirectory Server Transaction ID generated by the EMV 3DS Mastercard Directory Server during authentication.
DiscoverAuthAmountReturns the amount authorized for the transaction.
DiscoverPINCapababilityIndicates if the POS is capable of supporting a PIN.
DiscoverPOSEntryModeReturns the method by which the primary account number was entered at the POS.
DiscoverProcessingCodeReturns the type of Authorization request that was submitted to Discover.
DiscoverSystemTraceAuditNumberReturns the value assigned by the host/merhant to assist in identifying a specific transaction.
DiscoverTrackDataConditionReturns condition of the track data.
EMVOnlineKSNClear-text Key Sequence Number for EMV Online PIN transactions.
EMVOnlinePINDUKPT DES encrypted PIN block for EMV Online PIN transactions.
IsSplitShipmentIndicates the transaction is a Split Shipment.
MessageReasonCodeMessage Reason Code.
MITTransactionIdTransaction Identifier from the original authorization response. It is required when sending a Merchant Initiated Sale or AuthOnly transaction.
POSEntryModeCOFPOS Entry Mode Credential on File.
POSEnvironmentCodePOS Environment Code.
ProgramProtocolIndicates the version of 3D Secure used for authentication (Mastercard only).
RecurringSubmissionTypeIndicates the type of the recurring transaction.
RequestBalanceInfoSpecifies whether to request balance information.
RequestTransactionIdIndicates the Transaction Identifier is requested.
ResponseBalanceAmount1Credit Prepaid Available Balance #1.
ResponseBalanceAmount2Credit Prepaid Available Balance $2.
ResponseBalanceCurrency1Currency code for ResponseBalanceAmount1.
ResponseBalanceCurrency2Currency code for ResponseBalanceAmount2.
ResponsePOSRetrievalNumberPOS Retrieval Number sent in the request, echoed back in the response.
SettlementModeIndicates whether the component uses Paymentech's Host Capture or Terminal Capture system.
SplitShipmentSequenceNumberSplit Shipment Sequence Number.
SplitShipmentTotalNumberTotal Number of Shipments in a Split Shipment.
SystemInformationSystem Information field for Batch Inquiry and Release transactions.
UCAFCollectionIndicatorIndicates the merchant's level of support of UCAF Data Collection (Mastercard only).
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocolReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Payments SDK 2016 .NET Edition - Version 16.0 [Build 8017]