GlobalBatchMgr Class

Properties   Methods   Events   Config Settings   Errors  

The GlobalBatchMgr class 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 class offers four different services:

Property List

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

Method List

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

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.

Config Settings

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

BatchResponseApprovalCode Property (GlobalBatchMgr Class)

Contains the transaction authorization code from the card issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBatchResponseApprovalCode();

Unicode (Windows)
LPWSTR GetBatchResponseApprovalCode();

char* dpaymentssdk_globalbatchmgr_getbatchresponseapprovalcode(void* lpObj);

QString GetBatchResponseApprovalCode();

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 Class)

Indicates the number of the current batch.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBatchResponseBatchNumber();

Unicode (Windows)
LPWSTR GetBatchResponseBatchNumber();

char* dpaymentssdk_globalbatchmgr_getbatchresponsebatchnumber(void* lpObj);

QString GetBatchResponseBatchNumber();

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 Class)

Contains the transaction result code from the Global Transport Gateway.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBatchResponseCode();

Unicode (Windows)
LPWSTR GetBatchResponseCode();

char* dpaymentssdk_globalbatchmgr_getbatchresponsecode(void* lpObj);

QString GetBatchResponseCode();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBatchResponseMessage();

Unicode (Windows)
LPWSTR GetBatchResponseMessage();

char* dpaymentssdk_globalbatchmgr_getbatchresponsemessage(void* lpObj);

QString GetBatchResponseMessage();

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 Class)

Contains a formatted response message concerning the processed transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBatchResponseMessageDetail();

Unicode (Windows)
LPWSTR GetBatchResponseMessageDetail();

char* dpaymentssdk_globalbatchmgr_getbatchresponsemessagedetail(void* lpObj);

QString GetBatchResponseMessageDetail();

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 Class)

The net dollar amount of all transactions.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBatchResponseNetTransAmount();

Unicode (Windows)
LPWSTR GetBatchResponseNetTransAmount();

char* dpaymentssdk_globalbatchmgr_getbatchresponsenettransamount(void* lpObj);

QString GetBatchResponseNetTransAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBatchResponseNetTransCount();

Unicode (Windows)
INT GetBatchResponseNetTransCount();

int dpaymentssdk_globalbatchmgr_getbatchresponsenettranscount(void* lpObj);

int GetBatchResponseNetTransCount();

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 Class)

The date the batch was settled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBatchResponseSettleDate();

Unicode (Windows)
LPWSTR GetBatchResponseSettleDate();

char* dpaymentssdk_globalbatchmgr_getbatchresponsesettledate(void* lpObj);

QString GetBatchResponseSettleDate();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBenefitTransNetAmount();

Unicode (Windows)
LPWSTR GetBenefitTransNetAmount();

char* dpaymentssdk_globalbatchmgr_getbenefittransnetamount(void* lpObj);

QString GetBenefitTransNetAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBenefitTransNetCount();

Unicode (Windows)
INT GetBenefitTransNetCount();

int dpaymentssdk_globalbatchmgr_getbenefittransnetcount(void* lpObj);

int GetBenefitTransNetCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBenefitTransRefundAmount();

Unicode (Windows)
LPWSTR GetBenefitTransRefundAmount();

char* dpaymentssdk_globalbatchmgr_getbenefittransrefundamount(void* lpObj);

QString GetBenefitTransRefundAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBenefitTransRefundCount();

Unicode (Windows)
INT GetBenefitTransRefundCount();

int dpaymentssdk_globalbatchmgr_getbenefittransrefundcount(void* lpObj);

int GetBenefitTransRefundCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBenefitTransSaleAmount();

Unicode (Windows)
LPWSTR GetBenefitTransSaleAmount();

char* dpaymentssdk_globalbatchmgr_getbenefittranssaleamount(void* lpObj);

QString GetBenefitTransSaleAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBenefitTransSaleCount();

Unicode (Windows)
INT GetBenefitTransSaleCount();

int dpaymentssdk_globalbatchmgr_getbenefittranssalecount(void* lpObj);

int GetBenefitTransSaleCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckTransNetAmount();

Unicode (Windows)
LPWSTR GetCheckTransNetAmount();

char* dpaymentssdk_globalbatchmgr_getchecktransnetamount(void* lpObj);

QString GetCheckTransNetAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckTransNetCount();

Unicode (Windows)
INT GetCheckTransNetCount();

int dpaymentssdk_globalbatchmgr_getchecktransnetcount(void* lpObj);

int GetCheckTransNetCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckTransRefundAmount();

Unicode (Windows)
LPWSTR GetCheckTransRefundAmount();

char* dpaymentssdk_globalbatchmgr_getchecktransrefundamount(void* lpObj);

QString GetCheckTransRefundAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckTransRefundCount();

Unicode (Windows)
INT GetCheckTransRefundCount();

int dpaymentssdk_globalbatchmgr_getchecktransrefundcount(void* lpObj);

int GetCheckTransRefundCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCheckTransSaleAmount();

Unicode (Windows)
LPWSTR GetCheckTransSaleAmount();

char* dpaymentssdk_globalbatchmgr_getchecktranssaleamount(void* lpObj);

QString GetCheckTransSaleAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCheckTransSaleCount();

Unicode (Windows)
INT GetCheckTransSaleCount();

int dpaymentssdk_globalbatchmgr_getchecktranssalecount(void* lpObj);

int GetCheckTransSaleCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreditTransNetAmount();

Unicode (Windows)
LPWSTR GetCreditTransNetAmount();

char* dpaymentssdk_globalbatchmgr_getcredittransnetamount(void* lpObj);

QString GetCreditTransNetAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreditTransNetCount();

Unicode (Windows)
INT GetCreditTransNetCount();

int dpaymentssdk_globalbatchmgr_getcredittransnetcount(void* lpObj);

int GetCreditTransNetCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreditTransRefundAmount();

Unicode (Windows)
LPWSTR GetCreditTransRefundAmount();

char* dpaymentssdk_globalbatchmgr_getcredittransrefundamount(void* lpObj);

QString GetCreditTransRefundAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreditTransRefundCount();

Unicode (Windows)
INT GetCreditTransRefundCount();

int dpaymentssdk_globalbatchmgr_getcredittransrefundcount(void* lpObj);

int GetCreditTransRefundCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCreditTransSaleAmount();

Unicode (Windows)
LPWSTR GetCreditTransSaleAmount();

char* dpaymentssdk_globalbatchmgr_getcredittranssaleamount(void* lpObj);

QString GetCreditTransSaleAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreditTransSaleCount();

Unicode (Windows)
INT GetCreditTransSaleCount();

int dpaymentssdk_globalbatchmgr_getcredittranssalecount(void* lpObj);

int GetCreditTransSaleCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDebitTransNetAmount();

Unicode (Windows)
LPWSTR GetDebitTransNetAmount();

char* dpaymentssdk_globalbatchmgr_getdebittransnetamount(void* lpObj);

QString GetDebitTransNetAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDebitTransNetCount();

Unicode (Windows)
INT GetDebitTransNetCount();

int dpaymentssdk_globalbatchmgr_getdebittransnetcount(void* lpObj);

int GetDebitTransNetCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDebitTransRefundAmount();

Unicode (Windows)
LPWSTR GetDebitTransRefundAmount();

char* dpaymentssdk_globalbatchmgr_getdebittransrefundamount(void* lpObj);

QString GetDebitTransRefundAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDebitTransRefundCount();

Unicode (Windows)
INT GetDebitTransRefundCount();

int dpaymentssdk_globalbatchmgr_getdebittransrefundcount(void* lpObj);

int GetDebitTransRefundCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDebitTransSaleAmount();

Unicode (Windows)
LPWSTR GetDebitTransSaleAmount();

char* dpaymentssdk_globalbatchmgr_getdebittranssaleamount(void* lpObj);

QString GetDebitTransSaleAmount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDebitTransSaleCount();

Unicode (Windows)
INT GetDebitTransSaleCount();

int dpaymentssdk_globalbatchmgr_getdebittranssalecount(void* lpObj);

int GetDebitTransSaleCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetForceClose();
int SetForceClose(int bForceClose);

Unicode (Windows)
BOOL GetForceClose();
INT SetForceClose(BOOL bForceClose);

int dpaymentssdk_globalbatchmgr_getforceclose(void* lpObj);
int dpaymentssdk_globalbatchmgr_setforceclose(void* lpObj, int bForceClose);

bool GetForceClose();
int SetForceClose(bool bForceClose);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInquiryType();
int SetInquiryType(int iInquiryType);

Unicode (Windows)
INT GetInquiryType();
INT SetInquiryType(INT iInquiryType);

IT_CURRENT_BATCH(0), 
IT_PREVIOUS_BATCH(1)

int dpaymentssdk_globalbatchmgr_getinquirytype(void* lpObj);
int dpaymentssdk_globalbatchmgr_setinquirytype(void* lpObj, int iInquiryType);

int GetInquiryType();
int SetInquiryType(int iInquiryType);

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 Class)

Password for authentication with the Global Payments Server .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* dpaymentssdk_globalbatchmgr_getpassword(void* lpObj);
int dpaymentssdk_globalbatchmgr_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

ProxyAuthScheme Property (GlobalBatchMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int dpaymentssdk_globalbatchmgr_getproxyauthscheme(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Default Value

0

Remarks

This property is used to tell the class 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 class. Look at the configuration file for the class 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int dpaymentssdk_globalbatchmgr_getproxyautodetect(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyPassword Property (GlobalBatchMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* dpaymentssdk_globalbatchmgr_getproxypassword(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int dpaymentssdk_globalbatchmgr_getproxyport(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* dpaymentssdk_globalbatchmgr_getproxyserver(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int dpaymentssdk_globalbatchmgr_getproxyssl(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* dpaymentssdk_globalbatchmgr_getproxyuser(void* lpObj);
int dpaymentssdk_globalbatchmgr_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

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 Class)

Global Payments transaction server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServer();
int SetServer(const char* lpszServer);

Unicode (Windows)
LPWSTR GetServer();
INT SetServer(LPCWSTR lpszServer);

char* dpaymentssdk_globalbatchmgr_getserver(void* lpObj);
int dpaymentssdk_globalbatchmgr_setserver(void* lpObj, const char* lpszServer);

QString GetServer();
int SetServer(QString qsServer);

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 Class)

The number of records in the SetupField arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSetupFieldCount();

Unicode (Windows)
INT GetSetupFieldCount();

int dpaymentssdk_globalbatchmgr_getsetupfieldcount(void* lpObj);

int GetSetupFieldCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSetupFieldName(int iSetupFieldIndex);

Unicode (Windows)
LPWSTR GetSetupFieldName(INT iSetupFieldIndex);

char* dpaymentssdk_globalbatchmgr_getsetupfieldname(void* lpObj, int setupfieldindex);

QString GetSetupFieldName(int iSetupFieldIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSetupFieldValue(int iSetupFieldIndex);

Unicode (Windows)
LPWSTR GetSetupFieldValue(INT iSetupFieldIndex);

char* dpaymentssdk_globalbatchmgr_getsetupfieldvalue(void* lpObj, int setupfieldindex);

QString GetSetupFieldValue(int iSetupFieldIndex);

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 Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int dpaymentssdk_globalbatchmgr_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_globalbatchmgr_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

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.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (GlobalBatchMgr Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int dpaymentssdk_globalbatchmgr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_globalbatchmgr_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

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.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (GlobalBatchMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int dpaymentssdk_globalbatchmgr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_globalbatchmgr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

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).

Data Type

Binary String

SSLCertStorePassword Property (GlobalBatchMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* dpaymentssdk_globalbatchmgr_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

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 Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int dpaymentssdk_globalbatchmgr_getsslcertstoretype(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (GlobalBatchMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* dpaymentssdk_globalbatchmgr_getsslcertsubject(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

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 Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_globalbatchmgr_getsslprovider(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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 class 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 class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (GlobalBatchMgr Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int dpaymentssdk_globalbatchmgr_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

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.

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

Data Type

Binary String

SummaryBeginDate Property (GlobalBatchMgr Class)

Optional filter for use when retrieving a batch summary.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryBeginDate();
int SetSummaryBeginDate(const char* lpszSummaryBeginDate);

Unicode (Windows)
LPWSTR GetSummaryBeginDate();
INT SetSummaryBeginDate(LPCWSTR lpszSummaryBeginDate);

char* dpaymentssdk_globalbatchmgr_getsummarybegindate(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsummarybegindate(void* lpObj, const char* lpszSummaryBeginDate);

QString GetSummaryBeginDate();
int SetSummaryBeginDate(QString qsSummaryBeginDate);

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 Class)

Optional filter for use when retrieving a batch summary.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryEndDate();
int SetSummaryEndDate(const char* lpszSummaryEndDate);

Unicode (Windows)
LPWSTR GetSummaryEndDate();
INT SetSummaryEndDate(LPCWSTR lpszSummaryEndDate);

char* dpaymentssdk_globalbatchmgr_getsummaryenddate(void* lpObj);
int dpaymentssdk_globalbatchmgr_setsummaryenddate(void* lpObj, const char* lpszSummaryEndDate);

QString GetSummaryEndDate();
int SetSummaryEndDate(QString qsSummaryEndDate);

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 Class)

The number of records in the SummaryResult arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultCount();

Unicode (Windows)
INT GetSummaryResultCount();

int dpaymentssdk_globalbatchmgr_getsummaryresultcount(void* lpObj);

int GetSummaryResultCount();

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultAuthorizationAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultAuthorizationAmount(INT iSummaryIndex);

char* dpaymentssdk_globalbatchmgr_getsummaryresultauthorizationamount(void* lpObj, int summaryindex);

QString GetSummaryResultAuthorizationAmount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultAuthorizationCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultAuthorizationCount(INT iSummaryIndex);

int dpaymentssdk_globalbatchmgr_getsummaryresultauthorizationcount(void* lpObj, int summaryindex);

int GetSummaryResultAuthorizationCount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultCaptureAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultCaptureAmount(INT iSummaryIndex);

char* dpaymentssdk_globalbatchmgr_getsummaryresultcaptureamount(void* lpObj, int summaryindex);

QString GetSummaryResultCaptureAmount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultCaptureCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultCaptureCount(INT iSummaryIndex);

int dpaymentssdk_globalbatchmgr_getsummaryresultcapturecount(void* lpObj, int summaryindex);

int GetSummaryResultCaptureCount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultForceCaptureAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultForceCaptureAmount(INT iSummaryIndex);

char* dpaymentssdk_globalbatchmgr_getsummaryresultforcecaptureamount(void* lpObj, int summaryindex);

QString GetSummaryResultForceCaptureAmount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultForceCaptureCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultForceCaptureCount(INT iSummaryIndex);

int dpaymentssdk_globalbatchmgr_getsummaryresultforcecapturecount(void* lpObj, int summaryindex);

int GetSummaryResultForceCaptureCount(int iSummaryIndex);

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 Class)

The type of transactions being summarized.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultPaymentType(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultPaymentType(INT iSummaryIndex);

char* dpaymentssdk_globalbatchmgr_getsummaryresultpaymenttype(void* lpObj, int summaryindex);

QString GetSummaryResultPaymentType(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultPostAuthAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultPostAuthAmount(INT iSummaryIndex);

char* dpaymentssdk_globalbatchmgr_getsummaryresultpostauthamount(void* lpObj, int summaryindex);

QString GetSummaryResultPostAuthAmount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultPostAuthCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultPostAuthCount(INT iSummaryIndex);

int dpaymentssdk_globalbatchmgr_getsummaryresultpostauthcount(void* lpObj, int summaryindex);

int GetSummaryResultPostAuthCount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultRefundAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultRefundAmount(INT iSummaryIndex);

char* dpaymentssdk_globalbatchmgr_getsummaryresultrefundamount(void* lpObj, int summaryindex);

QString GetSummaryResultRefundAmount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultRefundCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultRefundCount(INT iSummaryIndex);

int dpaymentssdk_globalbatchmgr_getsummaryresultrefundcount(void* lpObj, int summaryindex);

int GetSummaryResultRefundCount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultRepeatSaleAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultRepeatSaleAmount(INT iSummaryIndex);

char* dpaymentssdk_globalbatchmgr_getsummaryresultrepeatsaleamount(void* lpObj, int summaryindex);

QString GetSummaryResultRepeatSaleAmount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultRepeatSaleCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultRepeatSaleCount(INT iSummaryIndex);

int dpaymentssdk_globalbatchmgr_getsummaryresultrepeatsalecount(void* lpObj, int summaryindex);

int GetSummaryResultRepeatSaleCount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSummaryResultSaleAmount(int iSummaryIndex);

Unicode (Windows)
LPWSTR GetSummaryResultSaleAmount(INT iSummaryIndex);

char* dpaymentssdk_globalbatchmgr_getsummaryresultsaleamount(void* lpObj, int summaryindex);

QString GetSummaryResultSaleAmount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultSaleCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultSaleCount(INT iSummaryIndex);

int dpaymentssdk_globalbatchmgr_getsummaryresultsalecount(void* lpObj, int summaryindex);

int GetSummaryResultSaleCount(int iSummaryIndex);

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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSummaryResultTotalCount(int iSummaryIndex);

Unicode (Windows)
INT GetSummaryResultTotalCount(INT iSummaryIndex);

int dpaymentssdk_globalbatchmgr_getsummaryresulttotalcount(void* lpObj, int summaryindex);

int GetSummaryResultTotalCount(int iSummaryIndex);

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 Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_globalbatchmgr_gettimeout(void* lpObj);
int dpaymentssdk_globalbatchmgr_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

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 class will wait for the operation to complete before returning control.

The class 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 class 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 Class)

UserId for authentication with the Global Payments Server .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserId();
int SetUserId(const char* lpszUserId);

Unicode (Windows)
LPWSTR GetUserId();
INT SetUserId(LPCWSTR lpszUserId);

char* dpaymentssdk_globalbatchmgr_getuserid(void* lpObj);
int dpaymentssdk_globalbatchmgr_setuserid(void* lpObj, const char* lpszUserId);

QString GetUserId();
int SetUserId(QString qsUserId);

Default Value

""

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

VendorNumber Property (GlobalBatchMgr Class)

The merchant's RP/Vendor number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVendorNumber();
int SetVendorNumber(const char* lpszVendorNumber);

Unicode (Windows)
LPWSTR GetVendorNumber();
INT SetVendorNumber(LPCWSTR lpszVendorNumber);

char* dpaymentssdk_globalbatchmgr_getvendornumber(void* lpObj);
int dpaymentssdk_globalbatchmgr_setvendornumber(void* lpObj, const char* lpszVendorNumber);

QString GetVendorNumber();
int SetVendorNumber(QString qsVendorNumber);

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 Class)

Retrieves the current state of the open batch.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BatchInquiry();

Unicode (Windows)
INT BatchInquiry();

int dpaymentssdk_globalbatchmgr_batchinquiry(void* lpObj);

int 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 class) 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CaptureAll Method (GlobalBatchMgr Class)

Marks the current batch for settlement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CaptureAll();

Unicode (Windows)
INT CaptureAll();

int dpaymentssdk_globalbatchmgr_captureall(void* lpObj);

int 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckConnection Method (GlobalBatchMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CheckConnection();

Unicode (Windows)
INT CheckConnection();

int dpaymentssdk_globalbatchmgr_checkconnection(void* lpObj);

int 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CheckSetup Method (GlobalBatchMgr Class)

Retrieves information about the merchant's current setup.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CheckSetup();

Unicode (Windows)
INT CheckSetup();

int dpaymentssdk_globalbatchmgr_checksetup(void* lpObj);

int CheckSetup();

Remarks

This method will return information relating to the merchant's current setup as name/value pairs. By default, the class 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (GlobalBatchMgr Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_globalbatchmgr_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetBatchSummary Method (GlobalBatchMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBatchSummary();

Unicode (Windows)
INT GetBatchSummary();

int dpaymentssdk_globalbatchmgr_getbatchsummary(void* lpObj);

int 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 class's GetTransactionSummary method instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (GlobalBatchMgr Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_globalbatchmgr_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (GlobalBatchMgr Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_globalbatchmgr_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (GlobalBatchMgr Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(GlobalBatchMgrErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} GlobalBatchMgrErrorEventParams;


Unicode (Windows)
virtual INT FireError(GlobalBatchMgrErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} GlobalBatchMgrErrorEventParams;

#define EID_GLOBALBATCHMGR_ERROR 1

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class GlobalBatchMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(GlobalBatchMgrErrorEventParams *e);

// Or, subclass GlobalBatchMgr and override this emitter function.
virtual int FireError(GlobalBatchMgrErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class 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 Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(GlobalBatchMgrSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} GlobalBatchMgrSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(GlobalBatchMgrSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} GlobalBatchMgrSSLServerAuthenticationEventParams;

#define EID_GLOBALBATCHMGR_SSLSERVERAUTHENTICATION 2

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class GlobalBatchMgrSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(GlobalBatchMgrSSLServerAuthenticationEventParams *e);

// Or, subclass GlobalBatchMgr and override this emitter function.
virtual int FireSSLServerAuthentication(GlobalBatchMgrSSLServerAuthenticationEventParams *e) {...}

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 Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(GlobalBatchMgrSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} GlobalBatchMgrSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(GlobalBatchMgrSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} GlobalBatchMgrSSLStatusEventParams;

#define EID_GLOBALBATCHMGR_SSLSTATUS 3

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class GlobalBatchMgrSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(GlobalBatchMgrSSLStatusEventParams *e);

// Or, subclass GlobalBatchMgr and override this emitter function.
virtual int FireSSLStatus(GlobalBatchMgrSSLStatusEventParams *e) {...}

Remarks

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

Status Event (GlobalBatchMgr Class)

Shows the progress of the Global Payments connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(GlobalBatchMgrStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} GlobalBatchMgrStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(GlobalBatchMgrStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} GlobalBatchMgrStatusEventParams;

#define EID_GLOBALBATCHMGR_STATUS 4

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);

class GlobalBatchMgrStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(GlobalBatchMgrStatusEventParams *e);

// Or, subclass GlobalBatchMgr and override this emitter function.
virtual int FireStatus(GlobalBatchMgrStatusEventParams *e) {...}

Remarks

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

Config Settings (GlobalBatchMgr Class)

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 Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GlobalBatchMgr Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors