PTechDebit Component
Properties Methods Events Configuration Settings Errors
The PTECHDEBIT component is used to complete debit card transactions with the Paymentech NetConnect system on the Tampa platform. This component supports only Retail, Restaurant, and Hotel environments, and allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection. This component can be integrated into Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application can be deployed without the need for expensive dedicated TLS/SSL servers.
Syntax
DPayments.DPaymentsSDK.Ptechdebit
Remarks
The PTechDebit component contains a subset of the PTechCharge component's functionality. It only authorizes debit card transactions for the Retail, Restaurant, and Hotel IndustryTypes. This component provides a much simpler interface for processing debit cards (and only debit cards), but otherwise works much like the PTechCharge component.
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 and PINCapability at this time.
Next, set the CardMagneticStripe property with Track 2 data read off the card. PIN-based Debit card transactions cannot be manually entered, and are always card-present transactions. Sending Track 1 data in the CardMagneticStripe property will result in a failed. You must also set the DebitKSN and DebitPIN retrieved from the PIN pad after the customer enters his PIN.
Finally, set the TransactionAmount and, and if applicable any DebitCashBack amount. Then call Sale to send the transaction to the Paymentech Server for processing.
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.
Debit card transactions are instant funds transfers. There is no block placed on the debit card, funds are immediately removed and sent to the merchant. Therefore, only the Host Capture settlement mode is supported. At the end of the day you should release the current batch using the PTechHostSettle component (the batch may contain other authorizations that were made using different components from this product. See the documentation for the other components you are using for more information).
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| CardMagneticStripe | Track 2 data read off of the card's magnetic stripe. |
| ClientNumber | Merchant configuration property, assigned by Paymentech. |
| DebitCashBack | Optional cash back amount for debit transactions. |
| DebitKSN | Clear-text Key Sequence Number, used for Debit transactions. |
| DebitPIN | DUKPT DES encrypted PIN block, used for Debit transactions. |
| DuplicateChecking | Indicates whether duplicate checking is enabled. |
| IndustryType | Determines the merchant's industry type. |
| InvoiceNumber | Merchant-generated invoice number. |
| MerchantNumber | A unique number used to identify the merchant, assigned by Paymentech. |
| Password | Password for authentication with the NetConnect Server . |
| PINCapability | Indicates if the terminal device supports a PIN pad. |
| POSRetrievalNumber | Merchant-generated reference number, used for reversals. |
| Proxy | A set of properties related to proxy access. |
| Response | Contains the response to an authorization. |
| SequenceNumber | Sequence number of the transaction. |
| Server | The URL for the PaymenTech NetConnect server. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| TerminalNumber | Terminal number assigned by Paymentech. |
| Timeout | A timeout for the component. |
| TransactionAmount | Purchase amount for an authorization. |
| UserId | UserId for authentication with the NetConnect Server . |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| Credit | Credits a cardholder's account. |
| Interrupt | Interrupt the current method. |
| Reset | Clears all properties to their default values. |
| Sale | Sends a Sale transaction to the host. |
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.
| DataPacketIn | Fired when receiving a data packet from the transaction server. |
| DataPacketOut | Fired when sending a data packet to the transaction server. |
| Error | Information about errors during data delivery. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows 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.
| AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
| CustomerDefinedData | Additional transaction identification data. |
| DeviceID | Used to specify the device user, retail lane, fuel pump, etc. to identify where the transaction originated from. |
| VendorID | Hardware/Vendor Identifier. |
| SoftwareID | Software Identifier. |
| HardwareSerialNum | Hardware Serial Number. |
| HostProcessingTypes | Host Processing Platform. |
| DiscoverProcessingCode | Returns the type of Authorization request that was submitted to Discover. |
| DiscoverSystemTraceAuditNumber | Returns the value assigned by the host/merhant to assist in identifying a specific transaction. |
| DiscoverPOSEntryMode | Returns the method by which the primary account number was entered at the POS. |
| DiscoverPINCapabability | Indicates if the POS is capable of supporting a PIN. |
| DiscoverTrackDataCondition | Returns condition of the track data. |
| DiscoverAuthAmount | Returns the amount authorized for the transaction. |
| RequestBalanceInfo | Specifies whether to request balance information. |
| SystemInformation | System Information field for Batch Inquiry and Release transactions. |
| SettlementMode | Indicates whether the component uses Paymentech's Host Capture or Terminal Capture system. |
| ResponsePOSRetrievalNumber | POS Retrieval Number sent in the request, echoed back in the response. |
| IsOfflinePINDebit | Specifies whether this is an Offline PIN Debit transaction. |
| EMVData | The EMV data returned from a Pin Pad after reading an EMV card. |
| EMVEntryDataSource | The EMV Data Entry Source (DES). |
| ResponseEMVData | The response EMV data. |
| ResponseEMVCardAuthCode | The ChaseNet and Visa card authentication results code. |
| ResponseEMVDownloadIndicator | Whether EMV parameters should be updated. |
| 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. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| LogLevel | The level of detail that is logged. |
| MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
| MaxHTTPCookies | Instructs component 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. |
| TransferredData | The contents of the last response from the server. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component 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 component binds to a SOCKS firewall as a server (IPPort 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. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| 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 component 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. |
| UseIPv6 | Whether to use IPv6. |
| UseNTLMv2 | Whether to use NTLM V2. |
| CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| 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. |
| GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
| UseBackgroundThread | Whether threads created by the component are background threads. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |