GlobalBatchMgr Control

Properties   Methods   Events   Config Settings   Errors  

The GlobalBatchMgr control 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:

Property List

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

Method List

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

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.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

BatchResponseApprovalCode Property (GlobalBatchMgr Control)

Contains the transaction authorization code from the card issuer.

Syntax

globalbatchmgrcontrol.BatchResponseApprovalCode

Default Value

""

Remarks

Contains the transaction authorization code from the card issuer.

For approved transaction responses (BatchResponseCode 0 or 200) the Global Transport Gateway sends a 6-character approval code in the BatchResponseApprovalCode property and a human-readable approval message in the BatchResponseMessage property. In the case of a decline, the BatchResponseApprovalCode will contain an error message. Your application should display the BatchResponseApprovalCode as part of the approval message for an approved transaction. For declined responses, the BatchResponseHostCode property will contain an additional code that provides detail on the reason for the decline.

After a call to CheckConnection this property will contain "OK" if everything is okay. If not, the BatchResponseCode, BatchResponseMessage, and BatchResponseMessageDetail will indicate the problem. For batch settlement responses it will contain the approval code. For all other transaction responses BatchResponseApprovalCode will remain empty.

This property is read-only.

Data Type

String

BatchResponseBatchNumber Property (GlobalBatchMgr Control)

Indicates the number of the current batch.

Syntax

globalbatchmgrcontrol.BatchResponseBatchNumber

Default Value

""

Remarks

Indicates the number of the current batch.

If this is a response to a BatchInquiry transaction, this property will contain the number of the current open batch. If in response to a CaptureAll transaction this property will contain the number of the batch that was just closed.

This property is read-only.

Data Type

String

BatchResponseCode Property (GlobalBatchMgr Control)

Contains the transaction result code from the Global Transport Gateway.

Syntax

globalbatchmgrcontrol.BatchResponseCode

Default Value

""

Remarks

Contains the transaction result code from the Global Transport Gateway. This value signifies the result of the transaction (i.e. approved, declined, etc). When programmatically validating a transaction's result, this value should ALWAYS be used instead of any response message describing the result. See the table below for a full list of result codes and descriptions.

A Partial Authorization transaction occurs when the issuer authorizes part of the sale amount on a pre-paid credit card. The transaction is approved for an amount less than the original TransactionAmount, and the customer must tender the remaining balance with another form of payment. When a transaction is partially approved, the BatchResponseCode will contain "200", the BatchResponseMessage will contain "Partial Approval", and the BatchResponseMessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the BatchResponseAuthorizedAmount will contain the amount of the transaction that was authorized, and the BatchResponseBalanceDue property will indicate the amount still owed by the customer.

If a partial authorization occurs and the customer does not wish to go through with the transaction, you must submit a reversal of the authorization in order to return funds to the prepaid card.

This property is read-only.

Data Type

String

BatchResponseMessage Property (GlobalBatchMgr Control)

Contains a human-readable response message concerning the processed transaction.

Syntax

globalbatchmgrcontrol.BatchResponseMessage

Default Value

""

Remarks

Contains a human-readable response message concerning the processed transaction.

This value is typically either Approved or Declined, but may also contain a description of any error condition. Do NOT use this when programmatically validating a transaction's result; use the BatchResponseCode property instead.

This property is read-only.

Data Type

String

BatchResponseMessageDetail Property (GlobalBatchMgr Control)

Contains a formatted response message concerning the processed transaction.

Syntax

globalbatchmgrcontrol.BatchResponseMessageDetail

Default Value

""

Remarks

Contains a formatted response message concerning the processed transaction. This property will contain an additional message about the results of the transaction, providing more detail than the BatchResponseMessage property alone. For approved transactions this property will typically be "APPROVAL", and for declined transactions will contain a detailed error message. Do NOT use this when programmatically validating a transaction's result; Use the BatchResponseCode property instead.

Note: For Debit Card Sales and Refund, the string value in BatchResponseMessageDetail includes non-printable characters. Global Transport removes all non-printable characters from the returned BatchResponseMessageDetail.

This property is read-only.

Data Type

String

BatchResponseNetTransAmount Property (GlobalBatchMgr Control)

The net dollar amount of all transactions.

Syntax

globalbatchmgrcontrol.BatchResponseNetTransAmount

Default Value

""

Remarks

The net dollar amount of all transactions.

This is the total transaction amount of the settlement, minus all refunds. If positive it indicates a payment to the merchant. If negative it means more refunds than sales were contained in the batch, and the merchant will be charged. Note that a void transaction DOES count towards the total BatchResponseNetTransAmount, but a Refund or Credit subtracts from it.

For instance, a batch containing one $10 transaction and one $10 void will have a BatchResponseNetTransAmount of "20.00". However, a batch containing one $10 transaction and one $3 refund will have a BatchResponseNetTransAmount of "7.00". In either case, the BatchResponseNetTransCount will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

BatchResponseNetTransCount Property (GlobalBatchMgr Control)

This property contains the total number of transactions contained in the batch settlement.

Syntax

globalbatchmgrcontrol.BatchResponseNetTransCount

Default Value

0

Remarks

This property contains the total number of transactions contained in the batch settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).

This property is read-only.

Data Type

Integer

BatchResponseSettleDate Property (GlobalBatchMgr Control)

The date the batch was settled.

Syntax

globalbatchmgrcontrol.BatchResponseSettleDate

Default Value

""

Remarks

The date the batch was settled. This date property is in the format "YYYY-MM-DD HH:MM:SS"

This property is read-only.

Data Type

String

BenefitTransNetAmount Property (GlobalBatchMgr Control)

The net dollar amount of all transactions of a particular transaction type.

Syntax

globalbatchmgrcontrol.BenefitTransNetAmount

Default Value

""

Remarks

The net dollar amount of all transactions of a particular transaction type.

This is the total amount of all the transactions (for this transaction type) in the settlement - including sales, voids, captures, and forces - minus all refunds/credits. If positive it indicates net payment to the merchant. If negative it means more refunds than sales were contained in the batch, and a net loss for the merchant. Note that a Void transaction DOES count towards the total BenefitTransNetAmount, but a Refund or Credit transaction subtracts from it.

For instance, a batch containing one $10 Charge and one $10 Void of this type will have a BenefitTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a BenefitTransNetAmount of "7.00". In either case, the BenefitTransNetCount will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

BenefitTransNetCount Property (GlobalBatchMgr Control)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.BenefitTransNetCount

Default Value

0

Remarks

This property contains the total number of transactions (for this transaction type) in the settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).

This property is read-only.

Data Type

Integer

BenefitTransRefundAmount Property (GlobalBatchMgr Control)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.BenefitTransRefundAmount

Default Value

""

Remarks

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

BenefitTransRefundCount Property (GlobalBatchMgr Control)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.BenefitTransRefundCount

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

BenefitTransSaleAmount Property (GlobalBatchMgr Control)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.BenefitTransSaleAmount

Default Value

""

Remarks

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

BenefitTransSaleCount Property (GlobalBatchMgr Control)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.BenefitTransSaleCount

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CheckTransNetAmount Property (GlobalBatchMgr Control)

The net dollar amount of all transactions of a particular transaction type.

Syntax

globalbatchmgrcontrol.CheckTransNetAmount

Default Value

""

Remarks

The net dollar amount of all transactions of a particular transaction type.

This is the total amount of all the transactions (for this transaction type) in the settlement - including sales, voids, captures, and forces - minus all refunds/credits. If positive it indicates net payment to the merchant. If negative it means more refunds than sales were contained in the batch, and a net loss for the merchant. Note that a Void transaction DOES count towards the total CheckTransNetAmount, but a Refund or Credit transaction subtracts from it.

For instance, a batch containing one $10 Charge and one $10 Void of this type will have a CheckTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a CheckTransNetAmount of "7.00". In either case, the CheckTransNetCount will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CheckTransNetCount Property (GlobalBatchMgr Control)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.CheckTransNetCount

Default Value

0

Remarks

This property contains the total number of transactions (for this transaction type) in the settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).

This property is read-only.

Data Type

Integer

CheckTransRefundAmount Property (GlobalBatchMgr Control)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.CheckTransRefundAmount

Default Value

""

Remarks

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CheckTransRefundCount Property (GlobalBatchMgr Control)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.CheckTransRefundCount

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CheckTransSaleAmount Property (GlobalBatchMgr Control)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.CheckTransSaleAmount

Default Value

""

Remarks

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CheckTransSaleCount Property (GlobalBatchMgr Control)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.CheckTransSaleCount

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CreditTransNetAmount Property (GlobalBatchMgr Control)

The net dollar amount of all transactions of a particular transaction type.

Syntax

globalbatchmgrcontrol.CreditTransNetAmount

Default Value

""

Remarks

The net dollar amount of all transactions of a particular transaction type.

This is the total amount of all the transactions (for this transaction type) in the settlement - including sales, voids, captures, and forces - minus all refunds/credits. If positive it indicates net payment to the merchant. If negative it means more refunds than sales were contained in the batch, and a net loss for the merchant. Note that a Void transaction DOES count towards the total CreditTransNetAmount, but a Refund or Credit transaction subtracts from it.

For instance, a batch containing one $10 Charge and one $10 Void of this type will have a CreditTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a CreditTransNetAmount of "7.00". In either case, the CreditTransNetCount will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CreditTransNetCount Property (GlobalBatchMgr Control)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.CreditTransNetCount

Default Value

0

Remarks

This property contains the total number of transactions (for this transaction type) in the settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).

This property is read-only.

Data Type

Integer

CreditTransRefundAmount Property (GlobalBatchMgr Control)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.CreditTransRefundAmount

Default Value

""

Remarks

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CreditTransRefundCount Property (GlobalBatchMgr Control)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.CreditTransRefundCount

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

CreditTransSaleAmount Property (GlobalBatchMgr Control)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.CreditTransSaleAmount

Default Value

""

Remarks

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

CreditTransSaleCount Property (GlobalBatchMgr Control)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.CreditTransSaleCount

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

DebitTransNetAmount Property (GlobalBatchMgr Control)

The net dollar amount of all transactions of a particular transaction type.

Syntax

globalbatchmgrcontrol.DebitTransNetAmount

Default Value

""

Remarks

The net dollar amount of all transactions of a particular transaction type.

This is the total amount of all the transactions (for this transaction type) in the settlement - including sales, voids, captures, and forces - minus all refunds/credits. If positive it indicates net payment to the merchant. If negative it means more refunds than sales were contained in the batch, and a net loss for the merchant. Note that a Void transaction DOES count towards the total DebitTransNetAmount, but a Refund or Credit transaction subtracts from it.

For instance, a batch containing one $10 Charge and one $10 Void of this type will have a DebitTransNetAmount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a DebitTransNetAmount of "7.00". In either case, the DebitTransNetCount will be 2.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

DebitTransNetCount Property (GlobalBatchMgr Control)

This property contains the total number of transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.DebitTransNetCount

Default Value

0

Remarks

This property contains the total number of transactions (for this transaction type) in the settlement. This includes charges, captures, voids, forces, and refunds, but not authorization-only transactions (as they are not added to the batch).

This property is read-only.

Data Type

Integer

DebitTransRefundAmount Property (GlobalBatchMgr Control)

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.DebitTransRefundAmount

Default Value

""

Remarks

This is the total amount of all Refund and Credit transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

DebitTransRefundCount Property (GlobalBatchMgr Control)

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.DebitTransRefundCount

Default Value

0

Remarks

This property contains the total number of Refund and Credit transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

DebitTransSaleAmount Property (GlobalBatchMgr Control)

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.DebitTransSaleAmount

Default Value

""

Remarks

This is the total amount of all Sale transactions (for this transaction type) in the settlement.

This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

This property is read-only.

Data Type

String

DebitTransSaleCount Property (GlobalBatchMgr Control)

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

Syntax

globalbatchmgrcontrol.DebitTransSaleCount

Default Value

0

Remarks

This property contains the total number of Sale transactions (for this transaction type) in the settlement.

This property is read-only.

Data Type

Integer

ForceClose Property (GlobalBatchMgr Control)

Forces a batch Capture even if there are mismatched transaction totals.

Syntax

globalbatchmgrcontrol.ForceClose[=boolean]

Default Value

False

Remarks

Calling CaptureAll with ForceClose set to True will settle all transactions for all payment types in the current batch regardless of whether the totals match with the Global Payments server (which can happen if there are timeouts or discrepancies based on other connectivity issues). This function should only be used when the merchant's account is setup for "merchant-initiated" close on the Global Payments server and if a normal CaptureAll batch close request fails with a "MUST BALANCE NOW" response.

Data Type

Boolean

InquiryType Property (GlobalBatchMgr Control)

Indicates whether to perform an inquiry on the current batch or on the previous batch.

Syntax

globalbatchmgrcontrol.InquiryType[=integer]

Possible Values

itCurrentBatch(0), 
itPreviousBatch(1)

Default Value

0

Remarks

This property is used by the BatchInquiry method to indicate whether you wish to retrieve results for the current open batch, or for the most recently closed batch. This property is not applicable for the GetBatchSummary method.

Data Type

Integer

Password Property (GlobalBatchMgr Control)

Password for authentication with the Global Payments Server .

Syntax

globalbatchmgrcontrol.Password[=string]

Default Value

""

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

ProxyAuthScheme Property (GlobalBatchMgr Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

globalbatchmgrcontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (GlobalBatchMgr Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

globalbatchmgrcontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (GlobalBatchMgr Control)

This property contains a password if authentication is to be used for the proxy.

Syntax

globalbatchmgrcontrol.ProxyPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (GlobalBatchMgr Control)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

globalbatchmgrcontrol.ProxyPort[=integer]

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (GlobalBatchMgr Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

globalbatchmgrcontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (GlobalBatchMgr Control)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

globalbatchmgrcontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (GlobalBatchMgr Control)

This property contains a username if authentication is to be used for the proxy.

Syntax

globalbatchmgrcontrol.ProxyUser[=string]

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

Server Property (GlobalBatchMgr Control)

Global Payments transaction server.

Syntax

globalbatchmgrcontrol.Server[=string]

Default Value

"https://api.globalpay.com"

Remarks

This is the server to which all transactions are sent. The live URL for Global Payments is "https://api.globalpay.com". For testing and certification purposes you may set this to the test server located at "https://certapia.globalpay.com" instead.

Data Type

String

SetupFieldCount Property (GlobalBatchMgr Control)

The number of records in the SetupField arrays.

Syntax

globalbatchmgrcontrol.SetupFieldCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• SetupFieldName
• SetupFieldValue

The array indices start at 0 and end at SetupFieldCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SetupFieldName Property (GlobalBatchMgr Control)

Contains the name of a property returned by Global Payments, which reflects the current state of the merchant setup.

Syntax

globalbatchmgrcontrol.SetupFieldName(SetupFieldIndex)

Default Value

""

Remarks

Contains the name of a field returned by Global Payments, which reflects the current state of the merchant setup.

The SetupFieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SetupFieldCount property.

This property is read-only and not available at design time.

Data Type

String

SetupFieldValue Property (GlobalBatchMgr Control)

Contains the value of a property returned by Global Payments, which reflects the current state of the merchant setup.

Syntax

globalbatchmgrcontrol.SetupFieldValue(SetupFieldIndex)

Default Value

""

Remarks

Contains the value of a field returned by Global Payments, which reflects the current state of the merchant setup.

The SetupFieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SetupFieldCount property.

This property is read-only and not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (GlobalBatchMgr Control)

This is the certificate (PEM/Base64 encoded).

Syntax

globalbatchmgrcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (GlobalBatchMgr Control)

This is the certificate (PEM/Base64 encoded).

Syntax

globalbatchmgrcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (GlobalBatchMgr Control)

This is the name of the certificate store for the client certificate.

Syntax

globalbatchmgrcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (GlobalBatchMgr Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

globalbatchmgrcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (GlobalBatchMgr Control)

This is the type of certificate store for this certificate.

Syntax

globalbatchmgrcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (GlobalBatchMgr Control)

This is the subject of the certificate used for client authentication.

Syntax

globalbatchmgrcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (GlobalBatchMgr Control)

This specifies the SSL/TLS implementation to use.

Syntax

globalbatchmgrcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (GlobalBatchMgr Control)

This is the certificate (PEM/Base64 encoded).

Syntax

globalbatchmgrcontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

SummaryBeginDate Property (GlobalBatchMgr Control)

Optional filter for use when retrieving a batch summary.

Syntax

globalbatchmgrcontrol.SummaryBeginDate[=string]

Default Value

""

Remarks

The begin date of the date range may be entered in "MM/DD/YYYY" format if you wish. This date will be converted by the Global system to: "MM/DD/YYYYT00:00:00:0000AM."

Data Type

String

SummaryEndDate Property (GlobalBatchMgr Control)

Optional filter for use when retrieving a batch summary.

Syntax

globalbatchmgrcontrol.SummaryEndDate[=string]

Default Value

""

Remarks

The end date of the date range may be entered in "MM/DD/YYYY" format if you wish. This date will be converted by the Global system to "MM/DD/YYYYT12:59:59:9999PM".

Data Type

String

SummaryResultCount Property (GlobalBatchMgr Control)

The number of records in the SummaryResult arrays.

Syntax

globalbatchmgrcontrol.SummaryResultCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• SummaryResultAuthorizationAmount
• SummaryResultAuthorizationCount
• SummaryResultCaptureAmount
• SummaryResultCaptureCount
• SummaryResultForceCaptureAmount
• SummaryResultForceCaptureCount
• SummaryResultPaymentType
• SummaryResultPostAuthAmount
• SummaryResultPostAuthCount
• SummaryResultRefundAmount
• SummaryResultRefundCount
• SummaryResultRepeatSaleAmount
• SummaryResultRepeatSaleCount
• SummaryResultSaleAmount
• SummaryResultSaleCount
• SummaryResultTotalCount

The array indices start at 0 and end at SummaryResultCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultAuthorizationAmount Property (GlobalBatchMgr Control)

Contains the dollar amount authorized for all transactions for the indicated PaymentType .

Syntax

globalbatchmgrcontrol.SummaryResultAuthorizationAmount(SummaryIndex)

Default Value

""

Remarks

Contains the dollar amount authorized for all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultAuthorizationCount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultAuthorizationCount(SummaryIndex)

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Authorization-only transactions for the indicated SummaryResultPaymentType. Auth-only transactions are also known as preauth transactions.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultCaptureAmount Property (GlobalBatchMgr Control)

Contains the dollar amount captured for all transactions for the indicated PaymentType .

Syntax

globalbatchmgrcontrol.SummaryResultCaptureAmount(SummaryIndex)

Default Value

""

Remarks

Contains the dollar amount captured for all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultCaptureCount Property (GlobalBatchMgr Control)

Contains the transaction count of all transactions that have been settled for the indicated PaymentType .

Syntax

globalbatchmgrcontrol.SummaryResultCaptureCount(SummaryIndex)

Default Value

0

Remarks

Contains the transaction count of all transactions that have been settled for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultForceCaptureAmount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultForceCaptureAmount(SummaryIndex)

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Force transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultForceCaptureCount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultForceCaptureCount(SummaryIndex)

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Force transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultPaymentType Property (GlobalBatchMgr Control)

The type of transactions being summarized.

Syntax

globalbatchmgrcontrol.SummaryResultPaymentType(SummaryIndex)

Default Value

""

Remarks

The type of transactions being summarized.

This field varies based on the value specified via SearchCriteriaCardBreakdown. When set to 'False', PaymentType will be set to transaction type returned in the response such as "Sale", "Return", "Force", etc.

When set to 'True', PaymentType will be set to the card and transaction type returned in the response and separated by " - " such as "VISA - Force", "MasterCard - Return", "Discover - Sale", etc.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultPostAuthAmount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultPostAuthAmount(SummaryIndex)

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all PreAuth Complete (Capture) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultPostAuthCount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultPostAuthCount(SummaryIndex)

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all PreAuth Complete (Capture) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultRefundAmount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultRefundAmount(SummaryIndex)

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Refund and Credit transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultRefundCount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultRefundCount(SummaryIndex)

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Refund and Credit transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultRepeatSaleAmount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultRepeatSaleAmount(SummaryIndex)

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all RepeatSale (Recurring Billing) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultRepeatSaleCount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultRepeatSaleCount(SummaryIndex)

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all RepeatSale (Recurring Billing) transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultSaleAmount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultSaleAmount(SummaryIndex)

Default Value

""

Remarks

* No longer supported as the underlying Global API has changed.

Contains the dollar amount of all Sale transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

String

SummaryResultSaleCount Property (GlobalBatchMgr Control)

* No longer supported as the underlying Global API has changed.

Syntax

globalbatchmgrcontrol.SummaryResultSaleCount(SummaryIndex)

Default Value

0

Remarks

* No longer supported as the underlying Global API has changed.

Contains the transaction count of all Sale transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

SummaryResultTotalCount Property (GlobalBatchMgr Control)

Contains the total count of all transactions for the indicated PaymentType .

Syntax

globalbatchmgrcontrol.SummaryResultTotalCount(SummaryIndex)

Default Value

0

Remarks

Contains the total count of all transactions for the indicated SummaryResultPaymentType.

The SummaryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SummaryResultCount property.

This property is read-only and not available at design time.

Data Type

Integer

Timeout Property (GlobalBatchMgr Control)

A timeout for the control.

Syntax

globalbatchmgrcontrol.Timeout[=integer]

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UserId Property (GlobalBatchMgr Control)

UserId for authentication with the Global Payments Server .

Syntax

globalbatchmgrcontrol.UserId[=string]

Default Value

""

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

VendorNumber Property (GlobalBatchMgr Control)

The merchant's RP/Vendor number.

Syntax

globalbatchmgrcontrol.VendorNumber[=string]

Default Value

""

Remarks

The Vendor number is also known as the "RP Number" or "RPNum", and is required by the GetBatchSummary method to retrieve information about transactions in the current open batch. If you do not know your Vendor/RPNum you may log into your Global Payments virtual terminal, or simply use the CheckSetup method to find it.

Data Type

String

BatchInquiry Method (GlobalBatchMgr Control)

Retrieves the current state of the open batch.

Syntax

globalbatchmgrcontrol.BatchInquiry 

Remarks

A batch inquiry will provide the host batch totals to the Point Of Sale (POS). If the POS and the Host are out of balance, discrepancies can be corrected (using the virtual terminal or GlobalTransactionSearch control) prior to the batch being captured. A batch inquiry will not release the batch for settlement. Use the CaptureAll method or Global Payments' online merchant interface to settle the batch.

The results of a batch inquiry will be returned in the BatchResponse property, and transaction totals will be contained in the CreditTransactions, DebitTransactions, BenefitTransactions, and CheckTransactions properties. To inquire about the most recent closed batch (instead of the current open batch), set the InquiryType property to itPreviousBatch.

CaptureAll Method (GlobalBatchMgr Control)

Marks the current batch for settlement.

Syntax

globalbatchmgrcontrol.CaptureAll 

Remarks

This operation will settle all transactions for all payment types in the current batch. This function should only be used when the merchant's account is setup for "merchant-initiated" close on the Global Payments server. The results of the CaptureAll will be returned in the BatchResponse property, and any transaction totals that may be returned will be contained in the CreditTransactions, DebitTransactions, BenefitTransactions, and CheckTransactions properties.

CheckConnection Method (GlobalBatchMgr Control)

Checks the connection status to the Global Payments server and validates login information.

Syntax

globalbatchmgrcontrol.CheckConnection 

Remarks

Returns "OK" in the BatchResponseApprovalCode property if a connection can be made to the Global Transport Gateway with the supplied UserId and Password otherwise the BatchResponseCode and BatchResponseMessage will indicate an error condition.

CheckSetup Method (GlobalBatchMgr Control)

Retrieves information about the merchant's current setup.

Syntax

globalbatchmgrcontrol.CheckSetup 

Remarks

This method will return information relating to the merchant's current setup as name/value pairs. By default, the control returns detailed information about the merchant. if you wish for a simpler response, the SetupResultMode configuration setting can be used to switch between basic and advanced (default) result modes. In either case, results of the CheckSetup method call will be contained within the SetupFields property.

Config Method (GlobalBatchMgr Control)

Sets or retrieves a configuration setting.

Syntax

globalbatchmgrcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetBatchSummary Method (GlobalBatchMgr Control)

Retrieves a summary of the current open batch for a merchant.

Syntax

globalbatchmgrcontrol.GetBatchSummary 

Remarks

* This method is no longer available as the underlying Global Transport API has changed. This method retrieves information about all of the transactions in the current open batch, and stores this information in the SummaryResults collection. The results will be separated by payment type ("MasterCard", "Visa", "DEBIT", etc.). You may optionally set a start and ending date to filter transactions with, using the SummaryBeginDate and SummaryEndDate properties.

To retrieve a summary of all transactions (even transactions that have already been settled) use the GlobalTransactionSearch control's GetTransactionSummary method instead.

Interrupt Method (GlobalBatchMgr Control)

Interrupt the current method.

Syntax

globalbatchmgrcontrol.Interrupt 

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Reset Method (GlobalBatchMgr Control)

Clears all properties to their default values.

Syntax

globalbatchmgrcontrol.Reset 

Remarks

This method clears all properties to their default values.

Error Event (GlobalBatchMgr Control)

Fired when information is available about errors during data delivery.

Syntax

Sub globalbatchmgrcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (GlobalBatchMgr Control)

Fired after the server presents its certificate to the client.

Syntax

Sub globalbatchmgrcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (GlobalBatchMgr Control)

Fired when secure connection progress messages are available.

Syntax

Sub globalbatchmgrcontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Status Event (GlobalBatchMgr Control)

Shows the progress of the Global Payments connection.

Syntax

Sub globalbatchmgrcontrol_Status(Message As String)

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (GlobalBatchMgr Control)

GlobalBatchMgr Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (GlobalBatchMgr Control)

GlobalBatchMgr Errors

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

SSL Errors

TCP/IP Errors