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

GlobalDebit Component

Properties   Methods   Events   Configuration Settings   Errors  

The GlobalDebit component is used to authorize debit card 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. 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.




The GlobalDebit component contains a subset of the GlobalCharge component's functionality. It only authorizes debit card transactions in the Retail and Restaurant industries. It cannot be used for eCommerce accounts. This component provides a much simpler interface for processing debit cards (and only debit cards), but otherwise works much like the GlobalCharge component.

First, set the UserId and Password with your login information. If you're submitting test transactions and are using a test account, set the Server to the certification URL ("https://certapia.globalpay.com").

Next, set the MagneticStripe field 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 MagneticStripe property will result in a failed transaction. You must also set the KSN and EncryptedPIN properties with data retrieved from the PIN pad after the customer enters their PIN.

Finally, set the TransactionAmount and if applicable, any CashBack amount. Then call Sale to send the transaction to the Global Transport 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, there is no ability to capture, void, or reverse debit transactions. You must use the Refund method to return funds to a customer's card. When performing a Refund, 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.

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.

ConfigSets or retrieves a configuration setting .
InterruptInterrupt the current method.
RefundRefunds a previous transaction.
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.

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.

PINCapableIndicates if the POS device is capable of accepting PINs.
ContactOnlyIndicates if the POS device is only able to accept chip inserted EMV transactions.
EMVCapableIndicates whether the Point of Sale is EMV enabled.
EMVDataThe EMV data returned from a Pin Pad after reading an EMV card.
ResponseEMVDataThe response EMV data.
EMVEntryDataSourceThe EMV Data Entry Source (DES).
RawRequestReturns the request sent to the server for debugging purposes.
RawResponseReturns the response received from the server for debugging purposes.
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]