GlobalCharge Class
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.
Class Name
InPayDirect_GlobalCharge
Procedural Interface
inpaydirect_globalcharge_open(); inpaydirect_globalcharge_close($res); inpaydirect_globalcharge_register_callback($res, $id, $function); inpaydirect_globalcharge_get_last_error($res); inpaydirect_globalcharge_get_last_error_code($res); inpaydirect_globalcharge_set($res, $id, $index, $value); inpaydirect_globalcharge_get($res, $id, $index); inpaydirect_globalcharge_do_authonly($res); inpaydirect_globalcharge_do_avsonly($res); inpaydirect_globalcharge_do_balanceinquiry($res); inpaydirect_globalcharge_do_capture($res, $pnref); inpaydirect_globalcharge_do_config($res, $configurationstring); inpaydirect_globalcharge_do_credit($res); inpaydirect_globalcharge_do_force($res, $approvalcode); inpaydirect_globalcharge_do_interrupt($res); inpaydirect_globalcharge_do_refund($res, $pnref); inpaydirect_globalcharge_do_repeatsale($res, $pnref); inpaydirect_globalcharge_do_reset($res); inpaydirect_globalcharge_do_reverse($res, $pnref); inpaydirect_globalcharge_do_sale($res); inpaydirect_globalcharge_do_tipadjustment($res, $pnref, $gratuityamount); inpaydirect_globalcharge_do_voidtransaction($res, $pnref);
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 class 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 class to capture the transactions in the batch.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
CardCVVData | Three digit security code on back of card (optional). |
CardCVVPresence | Indicates the presence of the card verification value. |
CardEntryDataSource | This property contains a 1-character code identifying the source of the customer data. |
CardExpMonth | Expiration month of the credit card specified in Number . |
CardExpYear | Expiration year of the credit card specified in Number . |
CardMagneticStripe | Track data read off of the card's magnetic stripe. |
CardNumber | Customer's credit card number for the transaction. |
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 . |
ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use SSL for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
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. |
ResponseApprovalCode | Contains the transaction authorization code from the card issuer. |
ResponseAuthorizedAmount | In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized. |
ResponseAVSResultCode | Contains the address verification result code from the card issuer. |
ResponseAVSResultMessage | Contains a formatted and human-readable response message describing the AVSResultCode . |
ResponseBalance | Available balance remaining on a pre-paid credit card. |
ResponseBalanceDue | In the case of a partial authorization, indicates the amount the customer still owes the merchant. |
ResponseBatchNumber | The number of the batch this transaction is currently contained in. |
ResponseCardType | Indicates the card type or payment method. |
ResponseCode | Contains the transaction result code from the Global Transport Gateway. |
ResponseCommercialCard | Indicates if the card that was just authorized was a commercial card. |
ResponseCVVResultCode | Contains the card verification result code from the card issuer. |
ResponseCVVResultMessage | Contains a formatted and human-readable response message describing the CVVResultCode . |
ResponseData | Contains the raw response data from the Global Payments host. |
ResponseHostCode | Action code returned by Global Payments. |
ResponseInvoiceNumber | Contains the same invoice number for the transaction that was originally sent in the request to the Global Transport Gateway. |
ResponseMerchantCode | Merchant Id code which must be printed on all receipts. |
ResponseMessage | Contains a human-readable response message concerning the processed transaction. |
ResponseMessageDetail | Contains a formatted response message concerning the processed transaction. |
ResponsePNRef | Contains a number which uniquely identifies the transaction in the Global Transport system. |
ResponseTransactionId | Card issuer's Transaction Reference Number. |
ResponseValidationCode | Visa Validation code. |
Server | Global Payments transaction server. |
ServerId | Unique server identification number. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If 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. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
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 class 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 class 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 class with short descriptions. Click on the links for further details.
DuplicateChecking | Enables or disables duplicate transaction checking. |
PNRef | Uniquely identifies the transaction in the Global Transport Gateway. |
CardVerify | Whether the transaction type is CardVerify. |
PINCapable | Indicates if a PIN pad is connected to the Point of Sale System / Terminal. |
CardPresent | Overrides merchant settings to perform a card present or card not present transaction. |
RawRequest | Returns the request sent to the server for debugging purposes. |
RawResponse | Returns the response received from the server for debugging purposes. |
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). |
ResponseEMVData | The response EMV data. |
EMVOnlinePIN | DUKPT DES encrypted PIN block for EMV Online PIN transactions. |
EMVOnlineKSN | Clear-text Key Sequence Number for EMV Online PIN transactions. |
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). |
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. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
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 TCP 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. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
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. |
CodePage | The system code page used for Unicode to Multibyte translations. |