4D Payments SDK 2016 .NET Edition

Questions / Feedback?

GlobalBenefit Component

Properties   Methods   Events   Configuration Settings   Errors  

The GlobalBenefit component is used to authorize Electronic Benefits Transfer (EBT) transactions with the Global Payments system, using the Global Transport Direct API. This component is supported in the Retail and Restaurant environments, and allows for simple, direct, secure communication to the Global Transport gateway through a standard Internet connection. An EBT transaction is similar to a Debit transaction, using a PIN and Key Sequence Number (KSN), but is used for Food Stamp or Cash Benefit programs.




An EBT Card (also known as Cash Benefit Card or Food Stamp Card) 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 UserId and Password, making sure that EBT transactions are allowed for your login credentials. If you're submitting test transaction and are using a test account, set the Server to the certification URL ("https://certapia.globalpay.com").

To send a transaction under normal circumstances, Track2 data should be read from the EBT card and placed in the MagneticStripe field. The EntryDataSource field should be set to edsMagneticStripe, and the EncryptedPIN and KSN properties should be filled with the encrypted PIN and key sequence number returned from 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, (and set the EntryDataSource field to edsManuallyEntered), but only for Food Stamp Transactions. Cash Benefit transactions may not be manually keyed.

Now simply set the TransactionAmount and call the Sale method to charge the card. You may also Refund funds back to the card (Food Stamp BenefitType only), as well as send a BalanceInquiry. Voice authorizations for Food Stamp transactions may be sent using the VoucherSale 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 GlobalCharge 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 TransactionId, as well as the available balance for the account accessed. Balances are returned in the FoodStampBalance and CashBenefitsBalance fields.

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, there is no ability to capture, void, or reverse EBT transactions. You must use the Refund method to return funds to a customer's card - but only for Food Stamp transactions. Cash Benefit Refund transactions are not allowed. Unlike the GlobalCharge component's Refund method, the MagneticStripe, EncryptedPIN, and KSN are required in addition to the PNRef parameter, which identifies the transaction you're issuing a refund for.

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.
CashBackOptional cash back amount to return to the customer.
CustomerNameThe cardholder's name as it appears on the card.
EncryptedPINDUKPT DES encrypted pin block, retrieved from a PIN pad.
InvoiceNumberOptional invoice tracking number.
KSNClear-text Key Serial Number retrieved from a PIN pad.
PasswordPassword for authentication with the Global Payments Server .
ProxyA set of properties related to proxy access.
RegisterNumberA number that uniquely identifies the register or computer on which the transaction was performed.
ResponseContains the response to an EBT transaction.
ServerGlobal Payments transaction 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.
TimeoutA timeout for the component.
TransactionAmountAmount to be charged from (or refunded to) the card.
UserIdUserId for authentication with the Global Payments 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 current balances of Food Stamp and Cash Benefit accounts on an EBT card.
ConfigSets or retrieves a configuration setting.
InterruptInterrupt the current method.
RefundSubmits a food stamp credit transaction, returning funds to an EBT card.
ResetClears all properties to their default values.
SaleSubmits a sale transaction for an Electronic Benefits (EBT) card.
VoucherSaleUsed to clear (force) a food stamp voucher that was previously voice-authorized.

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.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the Global Payments connection.

Configuration Settings

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

RawRequestReturns the request sent to the server for debugging purposes.
RawResponseReturns the response received from the server for debugging purposes.
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]