4D Payments SDK 2016 .NET Edition
4D Payments SDK 2016 .NET Edition
Questions / Feedback?

PTechBenefit Component

Properties   Methods   Events   Configuration Settings   Errors  

The PTechBenefit component is used to authorize Electronic Benefits Transfer (EBT) transactions with the Paymentech NetConnect system on the Tampa platform. An EBT transaction is similar to a Debit transaction, using a PIN and Trace number, but is used for Food Stamp or Cash Benefit programs. This component allows for simple, direct, secure communication to the Paymentech TLS/SSL gateway through a standard Internet connection.




An EBT Card (also known as Cash Benefit Card or Food Stamps) works similar to a bank debit card. EBT is a special application of electronic funds transfer (EFT), or debit card technology, which takes money directly from one account and transfers it to another (credit cards, by comparison, simply record a sale for payment later).

There are just a few steps to setting up the component and sending transactions. First, set the MerchantNumber, TerminalNumber, ClientNumber, UserId, and Password with the information given to you when you signed up for Paymentech service.

After the merchant information is setup, you may enter transaction data. Under normal circumstances, Track2 data should be read from the credit card and placed in the MagneticStripe. The EntryDataSource should be set to dsTrack2, and the CardPIN and CardKSN should be filled with the encrypted PIN and key sequence number returned by your PIN pad. If the card reader is unable to read the magnetic stripe, card info may be manually added in the Number, ExpMonth, and ExpYear fields. In this case, the EntryDataSource must be set to dsManuallyKeyed. These are the only two EntryDataSources supported for EBT cards.

Now simply set the TransactionAmount and call the Sale method to charge the card. You may also Credit funds back to the card (Food Stamp BenefitType only), as well as send a BalanceInquiry. Voice authorizations may be sent using the Force method.

The status of any of the above transactions will be stored in the Code field, with human-readable text appearing in Text. Like the PTechCharge component, there are several other Response fields which will contain data that should be logged.

EBT regulations require that all customer receipts include the last 4 digits of the Number and the Trace number, as well as the available balance for the account accessed. Balances are returned in the AvailableBalance and CashAvailableBalance fields. Additional Response balance fields contain extra information which the merchant may optionally include.

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

BenefitTypeIndicates whether the EBT card is a Food Stamps card or Cash Benefits card.
CardContains the customer's credit card information.
CardKSNClear-text Key Sequence Number that is associated with the CardPIN .
CardPINDUKPT DES encrypted PIN block.
CashBackOptional cash back amount for debit transactions.
ClientNumberMerchant configuration property, assigned by Paymentech.
DuplicateCheckingIndicates whether duplicate checking is enabled.
IndustryTypeDetermines the merchant's industry type.
MerchantNumberA unique number used to identify the merchant, assigned by Paymentech.
PasswordPassword for authentication with the NetConnect Server .
POSRetrievalNumberMerchant-generated reference number, used for reversals.
ProxyA set of properties related to proxy access.
ResponseContains the response to the 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.
TerminalNumberTerminal number assigned by Paymentech.
TimeoutA timeout for the component.
TransactionAmountPurchase amount for an authorization.
UserIdUserId 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.

BalanceInquiryRetrieves the balance remaining on an EBT card.
ConfigSets or retrieves a configuration setting .
CreditCredits a cardholder's account.
ForceSends a Force (Prior) transaction to the PaymenTech server.
InterruptInterrupt the current method.
ResetClears all properties to their default values.
SaleSends 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.

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.
DeviceIDUsed to specify the device user, retail lane, fuel pump, etc. to identify where the transaction originated from.
VendorIDHardware/Vendor Identifier.
SoftwareIDSoftware Identifier.
HardwareSerialNumHardware Serial Number.
HostProcessingTypesHost Processing Platform.
RequestBalanceInfoSpecifies whether to request balance information.
SystemInformationSystem Information field for Batch Inquiry and Release transactions.
SettlementModeIndicates whether the component uses Paymentech's Host Capture or Terminal Capture system.
ResponsePOSRetrievalNumberPOS Retrieval Number sent in the request, echoed back in the response.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
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.
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.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
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.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
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).
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.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
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.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
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.
CodePageThe system code page used for Unicode to Multibyte translations.

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