GlobalBatchMgr Component
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
DPayments.DPaymentsSDK.Globalbatchmgr
Remarks
This component offers four different services:
| CaptureAll |
Once a transaction request is approved with the GlobalCharge, GlobalDebit, or GlobalBenefit component, 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 component with short descriptions. Click on the links for further details.
| BatchResponse | Contains information about the current batch. |
| BenefitTransactions | Contains the transaction totals for Electronic Benefit (EBT) Cards. |
| CheckTransactions | Contains the transaction totals for electronic checks. |
| CreditTransactions | Contains the transaction totals for Credit Cards. |
| DebitTransactions | Contains the transaction totals for Debit Cards. |
| 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 . |
| Proxy | A set of properties related to proxy access. |
| Server | Global Payments transaction server. |
| SetupFields | Contains list of fields returned by Global Payments, which reflect the current state of the merchant setup. |
| 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. |
| SummaryBeginDate | Optional filter for use when retrieving a batch summary. |
| SummaryEndDate | Optional filter for use when retrieving a batch summary. |
| SummaryResults | Contains summary results for all payment types in the current batch. |
| 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 component 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 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.
| RawRequest | Returns the request sent to the server for debugging purposes. |
| RawResponse | Returns the response received from the server for debugging purposes. |
| SetupResultMode | Indicates whether to return simple or detailed information with the CheckSetup method. |
| 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. |