GlobalCharge Component
Properties Methods Events Configuration Settings Errors
The GlobalCharge component is used to authorize credit card transactions with the Global Payments system, using the Global Transport Direct API. This component supports Direct Marketing, e-Commerce, Retail, and Restaurant environments, and allows for simple, direct, secure communication to the Global Transport TLS/SSL gateway through a standard Internet connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.
Syntax
DPayments.DPaymentsSDK.Globalcharge
Remarks
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").
After the merchant information is setup, you may enter transaction data. When the credit card's EntryDataSource is Manually Entered, the merchant should fill the Number, ExpMonth, and ExpYear fields. Address Verification Service (AVS) data may be sent by filling the CustomerAddress and CustomerZip properties. For swiped transactions (Retail and Restaurant industries) the EntryDataSource should be set to edsMagneticStripe and, the MagneticStripe field should be filled with the trackdata read from the card. In addition, the TransactionAmount should be set with the total amount for the transaction.
Now simply call the Sale or AuthOnly method to send the authorization to the Global Transport Server.
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.
You may also use this component to Capture previously made AuthOnly transactions, void (VoidTransaction), Refund, and Reverse transactions, and validate address data without charging the card using AVSOnly.
Once a transaction request is approved, the transaction is added to the current batch on the Global Transport Server, and the money in the customer's account is blocked and tagged for the merchant. The transaction must go through Settlement in order for the blocked money to be transferred to the merchant's account.
If your Global Transport account is setup with the Host Auto Settle feature, you need take no further action. The Global Transport system will close the current open batch at a designated time each day. This means that there is no end of day batch processing required from the merchant.
If your account is not set up to automatically settle transactions at the end of the day, then at the end of the day you will need to use the GlobalBatchMgr component to capture the transactions in the batch.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
Card | Contains the customer's credit card information. |
CustomerAddress | Cardholder's billing street address, which is used for address verification. |
CustomerId | Contains a merchant-assigned number to identify the customer. |
CustomerName | The cardholder's name as it appears on the card. |
CustomerZip | The Cardholder's billing postal code, which is used in address verification. |
GratuityAmount | Tip portion of the TransactionAmount . |
InvoiceNumber | Optional invoice tracking number. |
Password | Password for authentication with the Global Payments Server . |
Proxy | A set of properties related to proxy access. |
PurchaseOrderNum | Required for the lowest rate on Commercial/Purchasing card (Level 2) transactions. |
RegisterNumber | A number that uniquely identifies the register or computer on which the transaction was performed. |
Response | Contains the response to a transaction. |
Server | Global Payments transaction server. |
ServerId | Unique server identification number. |
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. |
TaxAmount | Required for the lowest rate on Commercial/Purchasing card (Level 2) transactions. |
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 . |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AuthOnly | Sends an AuthOnly transaction to the host. |
AVSOnly | Performs AVS and CVV card validation checks without actually making a transaction. |
BalanceInquiry | A Credit Card Balance Inquiry transaction displays the remaining balance on a pre-paid credit card. |
Capture | Sends a capture transaction to the Global Payments Server. |
Config | Sets or retrieves a configuration setting. |
Credit | Credits a cardholder's account. |
Force | Sends a Voice Authorization (Force) transaction to the Global Payments Server. |
Interrupt | Interrupt the current method. |
Refund | Refunds a previous transaction. |
RepeatSale | Used to submit a recurring transaction. |
Reset | Clears all properties to their default values. |
Reverse | Reverses a transaction in the current batch. |
Sale | Sends a Sale transaction to the host. |
TipAdjustment | This methods adds a tip to the original sale transaction. |
VoidTransaction | Voids a transaction in the current batch. |
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.
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. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
CardPresent | Overrides merchant settings to perform a card present or card not present transaction. |
CardVerify | Whether the transaction type is CardVerify. |
ContactOnly | Indicates if the POS device is only able to accept chip inserted EMV transactions. |
DuplicateChecking | Enables or disables duplicate transaction checking. |
EMVCapable | Indicates whether the Point of Sale is EMV enabled. |
EMVData | The EMV data returned from a Pin Pad after reading an EMV card. |
EMVEntryDataSource | The EMV Data Entry Source (DES). |
EMVOnlineKSN | Clear-text Key Sequence Number for EMV Online PIN transactions. |
EMVOnlinePIN | DUKPT DES encrypted PIN block for EMV Online PIN transactions. |
PINCapable | Indicates if the POS device is capable of accepting PINs. |
PNRef | Uniquely identifies the transaction in the Global Transport Gateway. |
RawRequest | Returns the request sent to the server for debugging purposes. |
RawResponse | Returns the response received from the server for debugging purposes. |
ResponseEMVData | The response EMV data. |
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. |