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

Possible Values

GLOBALBATCHMGR_INQUIRYTYPE_CURRENT_BATCH(0), 
GLOBALBATCHMGR_INQUIRYTYPE_PREVIOUS_BATCH(1)

Default Value

0

Remarks

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

Data Type

Integer

Password Property (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)

The 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 );

Possible Values

GLOBALBATCHMGR_PROXYAUTHSCHEME_BASIC(0), 
GLOBALBATCHMGR_PROXYAUTHSCHEME_DIGEST(1), 
GLOBALBATCHMGR_PROXYAUTHSCHEME_PROPRIETARY(2), 
GLOBALBATCHMGR_PROXYAUTHSCHEME_NONE(3), 
GLOBALBATCHMGR_PROXYAUTHSCHEME_NTLM(4), 
GLOBALBATCHMGR_PROXYAUTHSCHEME_NEGOTIATE(5)

Default Value

0

Remarks

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

Whether 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

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (DPaymentsSDK_GlobalBatchMgr Class)

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

A password 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

ProxyPort Property (DPaymentsSDK_GlobalBatchMgr Class)

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

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)

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

Possible Values

GLOBALBATCHMGR_PROXYSSL_AUTOMATIC(0), 
GLOBALBATCHMGR_PROXYSSL_ALWAYS(1), 
GLOBALBATCHMGR_PROXYSSL_NEVER(2), 
GLOBALBATCHMGR_PROXYSSL_TUNNEL(3)

Default Value

0

Remarks

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)

A username 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

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 (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

SSLAcceptServerCertEffectiveDate Property (DPaymentsSDK_GlobalBatchMgr Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 47 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (DPaymentsSDK_GlobalBatchMgr Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 48 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (DPaymentsSDK_GlobalBatchMgr Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 49 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (DPaymentsSDK_GlobalBatchMgr Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 50 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (DPaymentsSDK_GlobalBatchMgr Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 51 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (DPaymentsSDK_GlobalBatchMgr Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 52 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (DPaymentsSDK_GlobalBatchMgr Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 53 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (DPaymentsSDK_GlobalBatchMgr Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 54 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (DPaymentsSDK_GlobalBatchMgr Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 55 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (DPaymentsSDK_GlobalBatchMgr Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 56 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (DPaymentsSDK_GlobalBatchMgr Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 57 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (DPaymentsSDK_GlobalBatchMgr Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 58 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (DPaymentsSDK_GlobalBatchMgr Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 59 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (DPaymentsSDK_GlobalBatchMgr Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 60 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (DPaymentsSDK_GlobalBatchMgr Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 61 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (DPaymentsSDK_GlobalBatchMgr Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 62 );
dpaymentssdk_globalbatchmgr_set($res, 62, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword 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 getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 63 );
dpaymentssdk_globalbatchmgr_set($res, 63, $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

SSLAcceptServerCertStoreType Property (DPaymentsSDK_GlobalBatchMgr Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 64 );
dpaymentssdk_globalbatchmgr_set($res, 64, $value );

Possible Values

GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_USER(0), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), 
GLOBALBATCHMGR_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (DPaymentsSDK_GlobalBatchMgr Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 65 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (DPaymentsSDK_GlobalBatchMgr Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 66 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (DPaymentsSDK_GlobalBatchMgr Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 67 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (DPaymentsSDK_GlobalBatchMgr Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 68 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (DPaymentsSDK_GlobalBatchMgr Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 69 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (DPaymentsSDK_GlobalBatchMgr Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 70 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (DPaymentsSDK_GlobalBatchMgr Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 71 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (DPaymentsSDK_GlobalBatchMgr Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 72 );
dpaymentssdk_globalbatchmgr_set($res, 72, $value );

Default Value

''

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLAcceptServerCertEncoded Property (DPaymentsSDK_GlobalBatchMgr Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 73 );
dpaymentssdk_globalbatchmgr_set($res, 73, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (DPaymentsSDK_GlobalBatchMgr Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 74 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (DPaymentsSDK_GlobalBatchMgr Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 75 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (DPaymentsSDK_GlobalBatchMgr Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 76 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (DPaymentsSDK_GlobalBatchMgr Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 77 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (DPaymentsSDK_GlobalBatchMgr Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 78 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (DPaymentsSDK_GlobalBatchMgr Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 79 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (DPaymentsSDK_GlobalBatchMgr Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 80 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (DPaymentsSDK_GlobalBatchMgr Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 81 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (DPaymentsSDK_GlobalBatchMgr Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 82 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (DPaymentsSDK_GlobalBatchMgr Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 83 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (DPaymentsSDK_GlobalBatchMgr Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 84 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (DPaymentsSDK_GlobalBatchMgr Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 85 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (DPaymentsSDK_GlobalBatchMgr Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 86 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (DPaymentsSDK_GlobalBatchMgr Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 87 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (DPaymentsSDK_GlobalBatchMgr Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 88 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (DPaymentsSDK_GlobalBatchMgr Class)

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, 89 );
dpaymentssdk_globalbatchmgr_set($res, 89, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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 (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, 90 );
dpaymentssdk_globalbatchmgr_set($res, 90, $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)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 91 );
dpaymentssdk_globalbatchmgr_set($res, 91, $value );

Possible Values

GLOBALBATCHMGR_SSLCERTSTORETYPE_USER(0), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_MACHINE(1), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_PFXFILE(2), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_PFXBLOB(3), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_JKSFILE(4), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_JKSBLOB(5), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_PEMKEY_FILE(6), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_PEMKEY_BLOB(7), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_P7BFILE(11), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_P7BBLOB(12), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_PPKFILE(14), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_PPKBLOB(15), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_XMLFILE(16), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_XMLBLOB(17), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_JWKFILE(18), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_JWKBLOB(19), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_SECURITY_KEY(20), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_BCFKSFILE(21), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_BCFKSBLOB(22), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_PKCS11(23), 
GLOBALBATCHMGR_SSLCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Data Type

Integer

SSLCertSubjectAltNames Property (DPaymentsSDK_GlobalBatchMgr Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 92 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (DPaymentsSDK_GlobalBatchMgr Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 93 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (DPaymentsSDK_GlobalBatchMgr Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 94 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (DPaymentsSDK_GlobalBatchMgr Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 95 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (DPaymentsSDK_GlobalBatchMgr Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 96 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (DPaymentsSDK_GlobalBatchMgr Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 97 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (DPaymentsSDK_GlobalBatchMgr Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 98 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (DPaymentsSDK_GlobalBatchMgr Class)

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, 99 );
dpaymentssdk_globalbatchmgr_set($res, 99, $value );

Default Value

''

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

Data Type

String

SSLCertEncoded Property (DPaymentsSDK_GlobalBatchMgr Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 100 );
dpaymentssdk_globalbatchmgr_set($res, 100, $value );

Default Value

''

Remarks

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

SSLProvider Property (DPaymentsSDK_GlobalBatchMgr Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 101 );
dpaymentssdk_globalbatchmgr_set($res, 101, $value );

Possible Values

GLOBALBATCHMGR_SSLPROVIDER_AUTOMATIC(0), 
GLOBALBATCHMGR_SSLPROVIDER_PLATFORM(1), 
GLOBALBATCHMGR_SSLPROVIDER_INTERNAL(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the 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 as follows:

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

SSLServerCertEffectiveDate Property (DPaymentsSDK_GlobalBatchMgr Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 102 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (DPaymentsSDK_GlobalBatchMgr Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 103 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (DPaymentsSDK_GlobalBatchMgr Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 104 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (DPaymentsSDK_GlobalBatchMgr Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 105 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (DPaymentsSDK_GlobalBatchMgr Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 106 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (DPaymentsSDK_GlobalBatchMgr Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 107 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (DPaymentsSDK_GlobalBatchMgr Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 108 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (DPaymentsSDK_GlobalBatchMgr Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 109 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (DPaymentsSDK_GlobalBatchMgr Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 110 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (DPaymentsSDK_GlobalBatchMgr Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 111 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (DPaymentsSDK_GlobalBatchMgr Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 112 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (DPaymentsSDK_GlobalBatchMgr Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 113 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (DPaymentsSDK_GlobalBatchMgr Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 114 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (DPaymentsSDK_GlobalBatchMgr Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 115 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (DPaymentsSDK_GlobalBatchMgr Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 116 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (DPaymentsSDK_GlobalBatchMgr Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 117 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword 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 getSSLServerCertStorePassword();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 118 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (DPaymentsSDK_GlobalBatchMgr Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 119 );

Possible Values

GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_USER(0), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_MACHINE(1), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_PFXFILE(2), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_PFXBLOB(3), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_JKSFILE(4), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_JKSBLOB(5), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_P7BFILE(11), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_P7BBLOB(12), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_PPKFILE(14), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_PPKBLOB(15), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_XMLFILE(16), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_XMLBLOB(17), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_JWKFILE(18), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_JWKBLOB(19), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_PKCS11(23), 
GLOBALBATCHMGR_SSLSERVERCERTSTORETYPE_AUTO(99)

Default Value

0

Remarks

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:

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (DPaymentsSDK_GlobalBatchMgr Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 120 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (DPaymentsSDK_GlobalBatchMgr Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 121 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (DPaymentsSDK_GlobalBatchMgr Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 122 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (DPaymentsSDK_GlobalBatchMgr Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 123 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (DPaymentsSDK_GlobalBatchMgr Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 124 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (DPaymentsSDK_GlobalBatchMgr Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 125 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (DPaymentsSDK_GlobalBatchMgr Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 126 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (DPaymentsSDK_GlobalBatchMgr Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 127 );

Default Value

''

Remarks

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=example@email.com". Common fields and their meanings are as follows:

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

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (DPaymentsSDK_GlobalBatchMgr Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dpaymentssdk_globalbatchmgr_get($res, 128 );

Default Value

''

Remarks

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