Direct Payment Integrator V6 - Online Help
Direct Payment Integrator V6
Questions / Feedback?

GlobalCharge Control

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

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 CardEntryDataSource is Manually Entered, the merchant should fill the CardNumber, CardExpMonth, and CardExpYear properties. Address Verification Service (AVS) data may be sent by filling the CustomerAddress and CustomerZip properties. For swiped transactions (Retail and Restaurant industries) the CardEntryDataSource should be set to edsMagneticStripe and, the CardMagneticStripe property 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 status of the authorization request will be stored in the ResponseCode property, with human-readable text appearing in the ResponseText property. There are several other Response properties which will contain data that should be logged.

You may also use this control 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 control to capture the transactions in the batch.

Property List


The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

CardCVVDataThree digit security code on back of card (optional).
CardCVVPresenceIndicates the presence of the card verification value.
CardEntryDataSourceThis property contains a 1-character code identifying the source of the customer data.
CardExpMonthExpiration month of the credit card specified in Number .
CardExpYearExpiration year of the credit card specified in Number .
CardMagneticStripeTrack data read off of the card's magnetic stripe.
CardNumberCustomer's credit card number for the transaction.
CustomerAddressCardholder's billing street address, which is used for address verification.
CustomerIdContains a merchant-assigned number to identify the customer.
CustomerNameThe cardholder's name as it appears on the card.
CustomerZipThe Cardholder's billing postal code, which is used in address verification.
GratuityAmountTip portion of the TransactionAmount .
InvoiceNumberOptional invoice tracking number.
PasswordPassword for authentication with the Global Payments Server .
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
PurchaseOrderNumRequired for the lowest rate on Commercial/Purchasing card (Level 2) transactions.
RegisterNumberA number that uniquely identifies the register or computer on which the transaction was performed.
ResponseApprovalCodeContains the transaction authorization code from the card issuer.
ResponseAuthorizedAmountIn the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.
ResponseAVSResultCodeContains the address verification result code from the card issuer.
ResponseAVSResultMessageContains a formatted and human-readable response message describing the AVSResultCode .
ResponseBalanceAvailable balance remaining on a pre-paid credit card.
ResponseBalanceDueIn the case of a partial authorization, indicates the amount the customer still owes the merchant.
ResponseBatchNumberThe number of the batch this transaction is currently contained in.
ResponseCardTypeIndicates the card type or payment method.
ResponseCodeContains the transaction result code from the Global Transport Gateway.
ResponseCommercialCardIndicates if the card that was just authorized was a commercial card.
ResponseCVVResultCodeContains the card verification result code from the card issuer.
ResponseCVVResultMessageContains a formatted and human-readable response message describing the CVVResultCode .
ResponseDataContains the raw response data from the Global Payments host.
ResponseHostCodeAction code returned by Global Payments.
ResponseInvoiceNumberContains the same invoice number for the transaction that was originally sent in the request to the Global Transport Gateway.
ResponseMerchantCodeMerchant Id code which must be printed on all receipts.
ResponseMessageContains a human-readable response message concerning the processed transaction.
ResponseMessageDetailContains a formatted response message concerning the processed transaction.
ResponsePNRefContains a number which uniquely identifies the transaction in the Global Transport system.
ResponseTransactionIdCard issuer's Transaction Reference Number.
ResponseValidationCodeVisa Validation code.
ServerGlobal Payments transaction server.
ServerIdUnique server identification number.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TaxAmountRequired for the lowest rate on Commercial/Purchasing card (Level 2) transactions.
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 control with short descriptions. Click on the links for further details.

AuthOnlySends an AuthOnly transaction to the host.
AVSOnlyPerforms AVS and CVV card validation checks without actually making a transaction.
BalanceInquiryA Credit Card Balance Inquiry transaction displays the remaining balance on a pre-paid credit card.
CaptureSends a capture transaction to the Global Payments Server.
ConfigSets or retrieves a configuration setting .
CreditCredits a cardholder's account.
ForceSends a Voice Authorization (Force) transaction to the Global Payments Server.
InterruptInterrupt the current method.
RefundRefunds a previous transaction.
RepeatSaleUsed to submit a recurring transaction.
ResetClears all properties to their default values.
ReverseReverses a transaction in the current batch.
SaleSends a Sale transaction to the host.
TipAdjustmentThis methods adds a tip to the original sale transaction.
VoidTransactionVoids a transaction in the current batch.

Event List


The following is the full list of the events fired by the control 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 control with short descriptions. Click on the links for further details.

DuplicateCheckingEnables or disables duplicate transaction checking.
PNRefUniquely identifies the transaction in the Global Transport Gateway.
CardVerifyWhether the transaction type is CardVerify.
PINCapableIndicates if a PIN pad is connected to the Point of Sale System / Terminal.
CardPresentOverrides merchant settings to perform a card present or card not present transaction.
RawRequestReturns the request sent to the server for debugging purposes.
RawResponseReturns the response received from the server for debugging purposes.
EMVCapableIndicates whether the Point of Sale is EMV enabled.
EMVDataThe EMV data returned from a Pin Pad after reading an EMV card.
EMVEntryDataSourceThe EMV Data Entry Source (DES).
ResponseEMVDataThe response EMV data.
EMVOnlinePINDUKPT DES encrypted PIN block for EMV Online PIN transactions.
EMVOnlineKSNClear-text Key Sequence Number for EMV Online PIN transactions.
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 TCP 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.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
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 /n software inc. - All rights reserved.
Build 6.0.6240.0