GlobalBatchMgr Control
Properties Methods Events Configuration Settings Errors
The GlobalBatchMgr component is used to manage your Global Transport account. It can be used to check the connection to the Server , verify your merchant setup, retrieve a summary of transactions in the current batch, and capture (settle) the current batch.
Syntax
GlobalBatchMgr
Remarks
This control offers four different services:
| CaptureAll |
Once a transaction request is approved with the GlobalCharge, GlobalDebit, or GlobalBenefit control, the transaction is added to the current batch on the Global Transport Server. For Debit and EBT cards the money is instantly transferred, but for Credit cards the money in the customer's account is blocked and tagged for the merchant, but not actually transferred yet. The credit card 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 CaptureAll method to capture the transactions in the batch. |
| CheckConnection | This method checks the status of the connection to the Global Payments server and validates the UserId and Password login credentials. |
| CheckSetup | This method will return detailed information relating to the merchant's current setup as name/value pairs in the SetupFields collection. |
| GetBatchSummary | This method retrieves information about all of the transactions in the current open batch, and stores this information in the SummaryResults collection. |
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
| BatchResponseApprovalCode | Contains the transaction authorization code from the card issuer. |
| BatchResponseBatchNumber | Indicates the number of the current batch. |
| BatchResponseCode | Contains the transaction result code from the Global Transport Gateway. |
| BatchResponseMessage | Contains a human-readable response message concerning the processed transaction. |
| BatchResponseMessageDetail | Contains a formatted response message concerning the processed transaction. |
| BatchResponseNetTransAmount | The net dollar amount of all transactions. |
| BatchResponseNetTransCount | This property contains the total number of transactions contained in the batch settlement. |
| BatchResponseSettleDate | The date the batch was settled. |
| BenefitTransNetAmount | The net dollar amount of all transactions of a particular transaction type. |
| BenefitTransNetCount | This property contains the total number of transactions (for this transaction type) in the settlement. |
| BenefitTransRefundAmount | This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement. |
| BenefitTransRefundCount | This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement. |
| BenefitTransSaleAmount | This is the total amount of all Sale transactions (for this transaction type) in the settlement. |
| BenefitTransSaleCount | This property contains the total number of Sale transactions (for this transaction type) in the settlement. |
| CheckTransNetAmount | The net dollar amount of all transactions of a particular transaction type. |
| CheckTransNetCount | This property contains the total number of transactions (for this transaction type) in the settlement. |
| CheckTransRefundAmount | This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement. |
| CheckTransRefundCount | This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement. |
| CheckTransSaleAmount | This is the total amount of all Sale transactions (for this transaction type) in the settlement. |
| CheckTransSaleCount | This property contains the total number of Sale transactions (for this transaction type) in the settlement. |
| CreditTransNetAmount | The net dollar amount of all transactions of a particular transaction type. |
| CreditTransNetCount | This property contains the total number of transactions (for this transaction type) in the settlement. |
| CreditTransRefundAmount | This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement. |
| CreditTransRefundCount | This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement. |
| CreditTransSaleAmount | This is the total amount of all Sale transactions (for this transaction type) in the settlement. |
| CreditTransSaleCount | This property contains the total number of Sale transactions (for this transaction type) in the settlement. |
| DebitTransNetAmount | The net dollar amount of all transactions of a particular transaction type. |
| DebitTransNetCount | This property contains the total number of transactions (for this transaction type) in the settlement. |
| DebitTransRefundAmount | This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement. |
| DebitTransRefundCount | This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement. |
| DebitTransSaleAmount | This is the total amount of all Sale transactions (for this transaction type) in the settlement. |
| DebitTransSaleCount | This property contains the total number of Sale transactions (for this transaction type) in the settlement. |
| ForceClose | Forces a batch Capture even if there are mismatched transaction totals. |
| InquiryType | Indicates whether to perform an inquiry on the current batch or on the previous batch. |
| 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. |
| Server | Global Payments transaction server. |
| SetupFieldCount | The number of records in the SetupField arrays. |
| SetupFieldName | Contains the name of a property returned by Global Payments, which reflects the current state of the merchant setup. |
| SetupFieldValue | Contains the value of a property returned by Global Payments, which reflects the current state of the merchant setup. |
| 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). |
| SummaryBeginDate | Optional filter for use when retrieving a batch summary. |
| SummaryEndDate | Optional filter for use when retrieving a batch summary. |
| SummaryResultCount | The number of records in the SummaryResult arrays. |
| SummaryResultAuthorizationAmount | Contains the dollar amount authorized for all transactions for the indicated PaymentType . |
| SummaryResultAuthorizationCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultCaptureAmount | Contains the dollar amount captured for all transactions for the indicated PaymentType . |
| SummaryResultCaptureCount | Contains the transaction count of all transactions that have been settled for the indicated PaymentType . |
| SummaryResultForceCaptureAmount | * No longer supported as the underlying Global API has changed. |
| SummaryResultForceCaptureCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultPaymentType | The type of transactions being summarized. |
| SummaryResultPostAuthAmount | * No longer supported as the underlying Global API has changed. |
| SummaryResultPostAuthCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultRefundAmount | * No longer supported as the underlying Global API has changed. |
| SummaryResultRefundCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultRepeatSaleAmount | * No longer supported as the underlying Global API has changed. |
| SummaryResultRepeatSaleCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultSaleAmount | * No longer supported as the underlying Global API has changed. |
| SummaryResultSaleCount | * No longer supported as the underlying Global API has changed. |
| SummaryResultTotalCount | Contains the total count of all transactions for the indicated PaymentType . |
| Timeout | A timeout for the component. |
| UserId | UserId for authentication with the Global Payments Server . |
| VendorNumber | The merchant's RP/Vendor number. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| BatchInquiry | Retrieves the current state of the open batch. |
| CaptureAll | Marks the current batch for settlement. |
| CheckConnection | Checks the connection status to the Global Payments server and validates login information. |
| CheckSetup | Retrieves information about the merchant's current setup. |
| Config | Sets or retrieves a configuration setting . |
| GetBatchSummary | Retrieves a summary of the current open batch for a merchant. |
| Interrupt | Interrupt the current method. |
| Reset | Clears all properties to their default values. |
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.
| 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 control with short descriptions. Click on the links for further details.
| SetupResultMode | Indicates whether to return simple or detailed information with the CheckSetup method. |
| RawRequest | Returns the request sent to the server for debugging purposes. |
| RawResponse | Returns the response received from the server for debugging purposes. |
| 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. |