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.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|BenefitType||Indicates whether the EBT card is a Food Stamps card or Cash Benefits card.|
|Card||Contains the customer's credit card information.|
|CashBack||Optional cash back amount to return to the customer.|
|CustomerName||The cardholder's name as it appears on the card.|
|EncryptedPIN||DUKPT DES encrypted pin block, retrieved from a PIN pad.|
|InvoiceNumber||Optional invoice tracking number.|
|KSN||Clear-text Key Serial Number retrieved from a PIN pad.|
|Password||Password for authentication with the Global Payments Server .|
|Proxy||A set of properties related to proxy access.|
|RegisterNumber||A number that uniquely identifies the register or computer on which the transaction was performed.|
|Response||Contains the response to an EBT transaction.|
|Server||Global Payments transaction 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.|
|Timeout||A timeout for the component.|
|TransactionAmount||Amount to be charged from (or refunded to) the card.|
|UserId||UserId for authentication with the Global Payments Server .|
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|BalanceInquiry||Retrieves the current balances of Food Stamp and Cash Benefit accounts on an EBT card.|
|Config||Sets or retrieves a configuration setting.|
|Interrupt||Interrupt the current method.|
|Refund||Submits a food stamp credit transaction, returning funds to an EBT card.|
|Reset||Clears all properties to their default values.|
|Sale||Submits a sale transaction for an Electronic Benefits (EBT) card.|
|VoucherSale||Used to clear (force) a food stamp voucher that was previously voice-authorized.|
The following is the full list of the events fired by the component 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||Shows the progress of the secure connection.|
|Status||Shows the progress of the Global Payments connection.|
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
|RawRequest||Returns the request sent to the server for debugging purposes.|
|RawResponse||Returns the response received from the server for debugging purposes.|
|CloseStreamAfterTransfer||If true, the component will close the upload or download stream after the transfer.|
|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.|
|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 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.|
|TcpNoDelay||Whether or not to delay when sending packets.|
|UseIPv6||Whether to use IPv6.|
|UseNTLMv2||Whether to use NTLM V2.|
|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.|
|SSLCACerts||A newline separated list of CA certificate to use during SSL client authentication.|
|SSLCheckCRL||Whether to check the Certificate Revocation List for the server certificate.|
|SSLCipherStrength||The minimum cipher strength used for bulk encryption.|
|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.|
|SSLNegotiatedCipher||Returns the negotiated ciphersuite.|
|SSLNegotiatedCipherStrength||Returns the negotiated ciphersuite strength.|
|SSLNegotiatedKeyExchange||Returns the negotiated key exchange algorithm.|
|SSLNegotiatedKeyExchangeStrength||Returns the negotiated key exchange algorithm strength.|
|SSLNegotiatedProtocol||Returns the negotiated protocol version.|
|SSLProvider||The name of the security provider to use.|
|SSLSecurityFlags||Flags that control certificate verification.|
|SSLServerCACerts||A newline separated list of CA certificate to use during SSL server certificate validation.|
|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.|
|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||Tells the component whether or not a message loop is available for processing events.|
|LicenseInfo||Information about the current license.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|