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.

Class Name

DPaymentsSDK_GlobalBatchMgr

Procedural Interface

 dpaymentssdk_globalbatchmgr_open();
 dpaymentssdk_globalbatchmgr_close($res);
 dpaymentssdk_globalbatchmgr_register_callback($res, $id, $function);
 dpaymentssdk_globalbatchmgr_get_last_error($res);
 dpaymentssdk_globalbatchmgr_get_last_error_code($res);
 dpaymentssdk_globalbatchmgr_set($res, $id, $index, $value);
 dpaymentssdk_globalbatchmgr_get($res, $id, $index);
 dpaymentssdk_globalbatchmgr_do_batchinquiry($res);
 dpaymentssdk_globalbatchmgr_do_captureall($res);
 dpaymentssdk_globalbatchmgr_do_checkconnection($res);
 dpaymentssdk_globalbatchmgr_do_checksetup($res);
 dpaymentssdk_globalbatchmgr_do_config($res, $configurationstring);
 dpaymentssdk_globalbatchmgr_do_getbatchsummary($res);
 dpaymentssdk_globalbatchmgr_do_interrupt($res);
 dpaymentssdk_globalbatchmgr_do_reset($res);

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

Contains the transaction authorization code from the card issuer.

Object Oriented Interface

public function getBatchResponseApprovalCode();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 1 );

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

Indicates the number of the current batch.

Object Oriented Interface

public function getBatchResponseBatchNumber();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 2 );

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

Contains the transaction result code from the Global Transport Gateway.

Object Oriented Interface

public function getBatchResponseCode();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 3 );

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

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

Object Oriented Interface

public function getBatchResponseMessage();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 4 );

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

Contains a formatted response message concerning the processed transaction.

Object Oriented Interface

public function getBatchResponseMessageDetail();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 5 );

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

The net dollar amount of all transactions.

Object Oriented Interface

public function getBatchResponseNetTransAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 6 );

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

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

Object Oriented Interface

public function getBatchResponseNetTransCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 7 );

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

The date the batch was settled.

Object Oriented Interface

public function getBatchResponseSettleDate();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 8 );

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

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

Object Oriented Interface

public function getBenefitTransNetAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 9 );

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

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

Object Oriented Interface

public function getBenefitTransNetCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 10 );

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

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

Object Oriented Interface

public function getBenefitTransRefundAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 11 );

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

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

Object Oriented Interface

public function getBenefitTransRefundCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 12 );

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

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

Object Oriented Interface

public function getBenefitTransSaleAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 13 );

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

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

Object Oriented Interface

public function getBenefitTransSaleCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 14 );

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

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

Object Oriented Interface

public function getCheckTransNetAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 15 );

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

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

Object Oriented Interface

public function getCheckTransNetCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 16 );

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

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

Object Oriented Interface

public function getCheckTransRefundAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 17 );

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

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

Object Oriented Interface

public function getCheckTransRefundCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 18 );

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

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

Object Oriented Interface

public function getCheckTransSaleAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 19 );

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

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

Object Oriented Interface

public function getCheckTransSaleCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 20 );

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

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

Object Oriented Interface

public function getCreditTransNetAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 21 );

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

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

Object Oriented Interface

public function getCreditTransNetCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 22 );

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

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

Object Oriented Interface

public function getCreditTransRefundAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 23 );

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

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

Object Oriented Interface

public function getCreditTransRefundCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 24 );

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

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

Object Oriented Interface

public function getCreditTransSaleAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 25 );

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

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

Object Oriented Interface

public function getCreditTransSaleCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 26 );

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

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

Object Oriented Interface

public function getDebitTransNetAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 27 );

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

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

Object Oriented Interface

public function getDebitTransNetCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 28 );

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

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

Object Oriented Interface

public function getDebitTransRefundAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 29 );

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

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

Object Oriented Interface

public function getDebitTransRefundCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 30 );

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

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

Object Oriented Interface

public function getDebitTransSaleAmount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 31 );

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

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

Object Oriented Interface

public function getDebitTransSaleCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 32 );

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

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

Object Oriented Interface

public function getForceClose();


public function setForceClose($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 33 );


dpaymentssdk_globalbatchmgr_set($res, 33, $value );

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

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

Object Oriented Interface

public function getInquiryType();


public function setInquiryType($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 34 );


dpaymentssdk_globalbatchmgr_set($res, 34, $value );

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

Password for authentication with the Global Payments Server .

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 35 );


dpaymentssdk_globalbatchmgr_set($res, 35, $value );

Default Value

''

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

ProxyAuthScheme Property (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 36 );


dpaymentssdk_globalbatchmgr_set($res, 36, $value );

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

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 37 );


dpaymentssdk_globalbatchmgr_set($res, 37, $value );

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

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

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 38 );


dpaymentssdk_globalbatchmgr_set($res, 38, $value );

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

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

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 39 );


dpaymentssdk_globalbatchmgr_set($res, 39, $value );

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

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 40 );


dpaymentssdk_globalbatchmgr_set($res, 40, $value );

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

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

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 41 );


dpaymentssdk_globalbatchmgr_set($res, 41, $value );

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

This property contains a user name, if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 42 );


dpaymentssdk_globalbatchmgr_set($res, 42, $value );

Default Value

''

Remarks

This property contains a user name, 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

Server Property (DPaymentsSDK_GlobalBatchMgr Class)

Global Payments transaction server.

Object Oriented Interface

public function getServer();


public function setServer($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 43 );


dpaymentssdk_globalbatchmgr_set($res, 43, $value );

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

The number of records in the SetupField arrays.

Object Oriented Interface

public function getSetupFieldCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 44 );

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

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

Object Oriented Interface

public function getSetupFieldName($setupfieldindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 45 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSetupFieldValue($setupfieldindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 46 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 48 );


dpaymentssdk_globalbatchmgr_set($res, 48, $value );

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

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 76 );


dpaymentssdk_globalbatchmgr_set($res, 76, $value );

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

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

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 92 );


dpaymentssdk_globalbatchmgr_set($res, 92, $value );

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 are designations of 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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DPaymentsSDK_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.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 93 );


dpaymentssdk_globalbatchmgr_set($res, 93, $value );

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

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 94 );


dpaymentssdk_globalbatchmgr_set($res, 94, $value );

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

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

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 95 );


dpaymentssdk_globalbatchmgr_set($res, 95, $value );

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 displayed below.

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

Data Type

String

SSLProvider Property (DPaymentsSDK_GlobalBatchMgr Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 103 );


dpaymentssdk_globalbatchmgr_set($res, 103, $value );

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

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 105 );

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

Optional filter for use when retrieving a batch summary.

Object Oriented Interface

public function getSummaryBeginDate();


public function setSummaryBeginDate($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 132 );


dpaymentssdk_globalbatchmgr_set($res, 132, $value );

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

Optional filter for use when retrieving a batch summary.

Object Oriented Interface

public function getSummaryEndDate();


public function setSummaryEndDate($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 133 );


dpaymentssdk_globalbatchmgr_set($res, 133, $value );

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

The number of records in the SummaryResult arrays.

Object Oriented Interface

public function getSummaryResultCount();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 134 );

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

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

Object Oriented Interface

public function getSummaryResultAuthorizationAmount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 135 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultAuthorizationCount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 136 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultCaptureAmount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 137 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultCaptureCount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 138 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultForceCaptureAmount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 139 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultForceCaptureCount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 140 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

The type of transactions being summarized.

Object Oriented Interface

public function getSummaryResultPaymentType($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 141 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultPostAuthAmount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 142 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultPostAuthCount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 143 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultRefundAmount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 144 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultRefundCount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 145 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultRepeatSaleAmount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 146 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultRepeatSaleCount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 147 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultSaleAmount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 148 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultSaleCount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 149 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function getSummaryResultTotalCount($summaryindex);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 150 , $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 (DPaymentsSDK_GlobalBatchMgr Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 151 );


dpaymentssdk_globalbatchmgr_set($res, 151, $value );

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

UserId for authentication with the Global Payments Server .

Object Oriented Interface

public function getUserId();


public function setUserId($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 152 );


dpaymentssdk_globalbatchmgr_set($res, 152, $value );

Default Value

''

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

VendorNumber Property (DPaymentsSDK_GlobalBatchMgr Class)

The merchant's RP/Vendor number.

Object Oriented Interface

public function getVendorNumber();


public function setVendorNumber($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 153 );


dpaymentssdk_globalbatchmgr_set($res, 153, $value );

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

Retrieves the current state of the open batch.

Object Oriented Interface

public function doBatchInquiry();

Procedural Interface

dpaymentssdk_globalbatchmgr_do_batchinquiry($res);

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.

CaptureAll Method (DPaymentsSDK_GlobalBatchMgr Class)

Marks the current batch for settlement.

Object Oriented Interface

public function doCaptureAll();

Procedural Interface

dpaymentssdk_globalbatchmgr_do_captureall($res);

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

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

Object Oriented Interface

public function doCheckConnection();

Procedural Interface

dpaymentssdk_globalbatchmgr_do_checkconnection($res);

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

Retrieves information about the merchant's current setup.

Object Oriented Interface

public function doCheckSetup();

Procedural Interface

dpaymentssdk_globalbatchmgr_do_checksetup($res);

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.

Config Method (DPaymentsSDK_GlobalBatchMgr Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dpaymentssdk_globalbatchmgr_do_config($res, $configurationstring);

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.

GetBatchSummary Method (DPaymentsSDK_GlobalBatchMgr Class)

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

Object Oriented Interface

public function doGetBatchSummary();

Procedural Interface

dpaymentssdk_globalbatchmgr_do_getbatchsummary($res);

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.

Interrupt Method (DPaymentsSDK_GlobalBatchMgr Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

dpaymentssdk_globalbatchmgr_do_interrupt($res);

Remarks

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

Reset Method (DPaymentsSDK_GlobalBatchMgr Class)

Clears all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dpaymentssdk_globalbatchmgr_do_reset($res);

Remarks

This method clears all properties to their default values.

Error Event (DPaymentsSDK_GlobalBatchMgr Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dpaymentssdk_globalbatchmgr_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

ErrorCode contains an error code and Description 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 (DPaymentsSDK_GlobalBatchMgr Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dpaymentssdk_globalbatchmgr_register_callback($res, 2, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dpaymentssdk_globalbatchmgr_register_callback($res, 3, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

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

Status Event (DPaymentsSDK_GlobalBatchMgr Class)

Shows the progress of the Global Payments connection.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

dpaymentssdk_globalbatchmgr_register_callback($res, 4, array($this, 'fireStatus'));

Parameter List

 'message'

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)

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