GlobalBatchMgr Class

Properties   Methods   Events   Config Settings   Errors  

The GlobalBatchMgr class is used to manage your Global Transport account. It can be used to check the connection to the Server , verify your merchant setup, retrieve a summary of transactions in the current batch, and capture (settle) the current batch.

Syntax

class dpaymentssdk.GlobalBatchMgr

Remarks

This class offers four different services:

Property List

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

Method List

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

Event List

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

Config Settings

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

batch_response_approval_code Property

Contains the transaction authorization code from the card issuer.

Syntax

def get_batch_response_approval_code() -> str: ...

batch_response_approval_code = property(get_batch_response_approval_code, None)

Default Value

""

Remarks

Contains the transaction authorization code from the card issuer.

For approved transaction responses (batch_response_code 0 or 200) the Global Transport Gateway sends a 6-character approval code in the batch_response_approval_code property and a human-readable approval message in the batch_response_message property. In the case of a decline, the batch_response_approval_code will contain an error message. Your application should display the batch_response_approval_code as part of the approval message for an approved transaction. For declined responses, the batch_response_host_code 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 batch_response_code, batch_response_message, and batch_response_message_detail will indicate the problem. For batch settlement responses it will contain the approval code. For all other transaction responses batch_response_approval_code will remain empty.

This property is read-only.

batch_response_batch_number Property

Indicates the number of the current batch.

Syntax

def get_batch_response_batch_number() -> str: ...

batch_response_batch_number = property(get_batch_response_batch_number, None)

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.

batch_response_code Property

Contains the transaction result code from the Global Transport Gateway.

Syntax

def get_batch_response_code() -> str: ...

batch_response_code = property(get_batch_response_code, None)

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 batch_response_code will contain "200", the batch_response_message will contain "Partial Approval", and the batch_response_message_detail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the batch_response_authorized_amount will contain the amount of the transaction that was authorized, and the batch_response_balance_due 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.

batch_response_message Property

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

Syntax

def get_batch_response_message() -> str: ...

batch_response_message = property(get_batch_response_message, None)

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 batch_response_code property instead.

This property is read-only.

batch_response_message_detail Property

Contains a formatted response message concerning the processed transaction.

Syntax

def get_batch_response_message_detail() -> str: ...

batch_response_message_detail = property(get_batch_response_message_detail, None)

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 batch_response_message 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 batch_response_code property instead.

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

This property is read-only.

batch_response_net_trans_amount Property

The net dollar amount of all transactions.

Syntax

def get_batch_response_net_trans_amount() -> str: ...

batch_response_net_trans_amount = property(get_batch_response_net_trans_amount, None)

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 batch_response_net_trans_amount, but a Refund or Credit subtracts from it.

For instance, a batch containing one $10 transaction and one $10 void will have a batch_response_net_trans_amount of "20.00". However, a batch containing one $10 transaction and one $3 refund will have a batch_response_net_trans_amount of "7.00". In either case, the batch_response_net_trans_count 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.

batch_response_net_trans_count Property

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

Syntax

def get_batch_response_net_trans_count() -> int: ...

batch_response_net_trans_count = property(get_batch_response_net_trans_count, None)

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.

batch_response_settle_date Property

The date the batch was settled.

Syntax

def get_batch_response_settle_date() -> str: ...

batch_response_settle_date = property(get_batch_response_settle_date, None)

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.

benefit_trans_net_amount Property

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

Syntax

def get_benefit_trans_net_amount() -> str: ...

benefit_trans_net_amount = property(get_benefit_trans_net_amount, None)

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 benefit_trans_net_amount, 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 benefit_trans_net_amount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a benefit_trans_net_amount of "7.00". In either case, the benefit_trans_net_count 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.

benefit_trans_net_count Property

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

Syntax

def get_benefit_trans_net_count() -> int: ...

benefit_trans_net_count = property(get_benefit_trans_net_count, None)

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.

benefit_trans_refund_amount Property

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

Syntax

def get_benefit_trans_refund_amount() -> str: ...

benefit_trans_refund_amount = property(get_benefit_trans_refund_amount, None)

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.

benefit_trans_refund_count Property

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

Syntax

def get_benefit_trans_refund_count() -> int: ...

benefit_trans_refund_count = property(get_benefit_trans_refund_count, None)

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.

benefit_trans_sale_amount Property

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

Syntax

def get_benefit_trans_sale_amount() -> str: ...

benefit_trans_sale_amount = property(get_benefit_trans_sale_amount, None)

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.

benefit_trans_sale_count Property

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

Syntax

def get_benefit_trans_sale_count() -> int: ...

benefit_trans_sale_count = property(get_benefit_trans_sale_count, None)

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.

check_trans_net_amount Property

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

Syntax

def get_check_trans_net_amount() -> str: ...

check_trans_net_amount = property(get_check_trans_net_amount, None)

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 check_trans_net_amount, 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 check_trans_net_amount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a check_trans_net_amount of "7.00". In either case, the check_trans_net_count 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.

check_trans_net_count Property

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

Syntax

def get_check_trans_net_count() -> int: ...

check_trans_net_count = property(get_check_trans_net_count, None)

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.

check_trans_refund_amount Property

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

Syntax

def get_check_trans_refund_amount() -> str: ...

check_trans_refund_amount = property(get_check_trans_refund_amount, None)

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.

check_trans_refund_count Property

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

Syntax

def get_check_trans_refund_count() -> int: ...

check_trans_refund_count = property(get_check_trans_refund_count, None)

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.

check_trans_sale_amount Property

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

Syntax

def get_check_trans_sale_amount() -> str: ...

check_trans_sale_amount = property(get_check_trans_sale_amount, None)

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.

check_trans_sale_count Property

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

Syntax

def get_check_trans_sale_count() -> int: ...

check_trans_sale_count = property(get_check_trans_sale_count, None)

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.

credit_trans_net_amount Property

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

Syntax

def get_credit_trans_net_amount() -> str: ...

credit_trans_net_amount = property(get_credit_trans_net_amount, None)

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 credit_trans_net_amount, 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 credit_trans_net_amount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a credit_trans_net_amount of "7.00". In either case, the credit_trans_net_count 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.

credit_trans_net_count Property

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

Syntax

def get_credit_trans_net_count() -> int: ...

credit_trans_net_count = property(get_credit_trans_net_count, None)

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.

credit_trans_refund_amount Property

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

Syntax

def get_credit_trans_refund_amount() -> str: ...

credit_trans_refund_amount = property(get_credit_trans_refund_amount, None)

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.

credit_trans_refund_count Property

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

Syntax

def get_credit_trans_refund_count() -> int: ...

credit_trans_refund_count = property(get_credit_trans_refund_count, None)

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.

credit_trans_sale_amount Property

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

Syntax

def get_credit_trans_sale_amount() -> str: ...

credit_trans_sale_amount = property(get_credit_trans_sale_amount, None)

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.

credit_trans_sale_count Property

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

Syntax

def get_credit_trans_sale_count() -> int: ...

credit_trans_sale_count = property(get_credit_trans_sale_count, None)

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.

debit_trans_net_amount Property

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

Syntax

def get_debit_trans_net_amount() -> str: ...

debit_trans_net_amount = property(get_debit_trans_net_amount, None)

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 debit_trans_net_amount, 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 debit_trans_net_amount of "20.00". However, a batch containing one $10 Charge and one $3 Refund of this type will have a debit_trans_net_amount of "7.00". In either case, the debit_trans_net_count 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.

debit_trans_net_count Property

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

Syntax

def get_debit_trans_net_count() -> int: ...

debit_trans_net_count = property(get_debit_trans_net_count, None)

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.

debit_trans_refund_amount Property

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

Syntax

def get_debit_trans_refund_amount() -> str: ...

debit_trans_refund_amount = property(get_debit_trans_refund_amount, None)

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.

debit_trans_refund_count Property

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

Syntax

def get_debit_trans_refund_count() -> int: ...

debit_trans_refund_count = property(get_debit_trans_refund_count, None)

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.

debit_trans_sale_amount Property

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

Syntax

def get_debit_trans_sale_amount() -> str: ...

debit_trans_sale_amount = property(get_debit_trans_sale_amount, None)

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.

debit_trans_sale_count Property

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

Syntax

def get_debit_trans_sale_count() -> int: ...

debit_trans_sale_count = property(get_debit_trans_sale_count, None)

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.

force_close Property

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

Syntax

def get_force_close() -> bool: ...
def set_force_close(value: bool) -> None: ...

force_close = property(get_force_close, set_force_close)

Default Value

FALSE

Remarks

Calling capture_all with force_close 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 capture_all batch close request fails with a "MUST BALANCE NOW" response.

inquiry_type Property

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

Syntax

def get_inquiry_type() -> int: ...
def set_inquiry_type(value: int) -> None: ...

inquiry_type = property(get_inquiry_type, set_inquiry_type)

Default Value

0

Remarks

This property is used by the batch_inquiry 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 get_batch_summary method.

password Property

Password for authentication with the Global Payments Server .

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

The password will be supplied to you by Global Payments.

proxy_auth_scheme Property

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

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

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

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the component will attempt basic authentication.

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

If proxy_auth_scheme 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 proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

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

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

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

proxy_password Property

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

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

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

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

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

proxy_server Property

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

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

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

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

proxy_ssl Property

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

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

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

proxy_user Property

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

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

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

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

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

server Property

Global Payments transaction server.

Syntax

def get_server() -> str: ...
def set_server(value: str) -> None: ...

server = property(get_server, set_server)

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.

setup_field_count Property

The number of records in the SetupField arrays.

Syntax

def get_setup_field_count() -> int: ...

setup_field_count = property(get_setup_field_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• setup_field_name
• setup_field_value

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

This property is read-only.

setup_field_name Property

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

Syntax

def get_setup_field_name(setup_field_index: int) -> str: ...

Default Value

""

Remarks

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

The setup_field_index parameter specifies the index of the item in the array. The size of the array is controlled by the setup_field_count property.

This property is read-only.

setup_field_value Property

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

Syntax

def get_setup_field_value(setup_field_index: int) -> str: ...

Default Value

""

Remarks

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

The setup_field_index parameter specifies the index of the item in the array. The size of the array is controlled by the setup_field_count property.

This property is read-only.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

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

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

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

Possible values are:

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

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

ssl_server_cert_encoded Property

This is the certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

summary_begin_date Property

Optional filter for use when retrieving a batch summary.

Syntax

def get_summary_begin_date() -> str: ...
def set_summary_begin_date(value: str) -> None: ...

summary_begin_date = property(get_summary_begin_date, set_summary_begin_date)

Default Value

""

Remarks

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

summary_end_date Property

Optional filter for use when retrieving a batch summary.

Syntax

def get_summary_end_date() -> str: ...
def set_summary_end_date(value: str) -> None: ...

summary_end_date = property(get_summary_end_date, set_summary_end_date)

Default Value

""

Remarks

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

summary_result_count Property

The number of records in the SummaryResult arrays.

Syntax

def get_summary_result_count() -> int: ...

summary_result_count = property(get_summary_result_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• summary_result_authorization_amount
• summary_result_authorization_count
• summary_result_capture_amount
• summary_result_capture_count
• summary_result_force_capture_amount
• summary_result_force_capture_count
• summary_result_payment_type
• summary_result_post_auth_amount
• summary_result_post_auth_count
• summary_result_refund_amount
• summary_result_refund_count
• summary_result_repeat_sale_amount
• summary_result_repeat_sale_count
• summary_result_sale_amount
• summary_result_sale_count
• summary_result_total_count

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

This property is read-only.

summary_result_authorization_amount Property

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

Syntax

def get_summary_result_authorization_amount(summary_index: int) -> str: ...

Default Value

""

Remarks

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_authorization_count Property

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

Syntax

def get_summary_result_authorization_count(summary_index: int) -> int: ...

Default Value

0

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_capture_amount Property

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

Syntax

def get_summary_result_capture_amount(summary_index: int) -> str: ...

Default Value

""

Remarks

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_capture_count Property

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

Syntax

def get_summary_result_capture_count(summary_index: int) -> int: ...

Default Value

0

Remarks

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_force_capture_amount Property

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

Syntax

def get_summary_result_force_capture_amount(summary_index: int) -> str: ...

Default Value

""

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_force_capture_count Property

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

Syntax

def get_summary_result_force_capture_count(summary_index: int) -> int: ...

Default Value

0

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_payment_type Property

The type of transactions being summarized.

Syntax

def get_summary_result_payment_type(summary_index: int) -> str: ...

Default Value

""

Remarks

The type of transactions being summarized.

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_post_auth_amount Property

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

Syntax

def get_summary_result_post_auth_amount(summary_index: int) -> str: ...

Default Value

""

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_post_auth_count Property

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

Syntax

def get_summary_result_post_auth_count(summary_index: int) -> int: ...

Default Value

0

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_refund_amount Property

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

Syntax

def get_summary_result_refund_amount(summary_index: int) -> str: ...

Default Value

""

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_refund_count Property

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

Syntax

def get_summary_result_refund_count(summary_index: int) -> int: ...

Default Value

0

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_repeat_sale_amount Property

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

Syntax

def get_summary_result_repeat_sale_amount(summary_index: int) -> str: ...

Default Value

""

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_repeat_sale_count Property

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

Syntax

def get_summary_result_repeat_sale_count(summary_index: int) -> int: ...

Default Value

0

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_sale_amount Property

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

Syntax

def get_summary_result_sale_amount(summary_index: int) -> str: ...

Default Value

""

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_sale_count Property

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

Syntax

def get_summary_result_sale_count(summary_index: int) -> int: ...

Default Value

0

Remarks

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

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

summary_result_total_count Property

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

Syntax

def get_summary_result_total_count(summary_index: int) -> int: ...

Default Value

0

Remarks

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

The summary_index parameter specifies the index of the item in the array. The size of the array is controlled by the summary_result_count property.

This property is read-only.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

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

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

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

If timeout expires, and the operation is not yet complete, the class fails with an error.

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

The default value for the timeout property is 60 seconds.

user_id Property

UserId for authentication with the Global Payments Server .

Syntax

def get_user_id() -> str: ...
def set_user_id(value: str) -> None: ...

user_id = property(get_user_id, set_user_id)

Default Value

""

Remarks

The user_id will be supplied to you by Global Payments.

vendor_number Property

The merchant's RP/Vendor number.

Syntax

def get_vendor_number() -> str: ...
def set_vendor_number(value: str) -> None: ...

vendor_number = property(get_vendor_number, set_vendor_number)

Default Value

""

Remarks

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

batch_inquiry Method

Retrieves the current state of the open batch.

Syntax

def batch_inquiry() -> None: ...

Remarks

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

The results of a batch inquiry will be returned in the batch_response property, and transaction totals will be contained in the credit_transactions, debit_transactions, benefit_transactions, and check_transactions properties. To inquire about the most recent closed batch (instead of the current open batch), set the inquiry_type property to itPreviousBatch.

capture_all Method

Marks the current batch for settlement.

Syntax

def capture_all() -> None: ...

Remarks

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

check_connection Method

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

Syntax

def check_connection() -> None: ...

Remarks

Returns "OK" in the batch_response_approval_code property if a connection can be made to the Global Transport Gateway with the supplied user_id and password otherwise the batch_response_code and batch_response_message will indicate an error condition.

check_setup Method

Retrieves information about the merchant's current setup.

Syntax

def check_setup() -> None: ...

Remarks

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

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

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

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

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

get_batch_summary Method

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

Syntax

def get_batch_summary() -> None: ...

Remarks

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

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

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

reset Method

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

This method clears all properties to their default values.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class GlobalBatchMgrErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class GlobalBatchMgr:
@property
def on_error() -> Callable[[GlobalBatchMgrErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[GlobalBatchMgrErrorEventParams], None]) -> None: ...

Remarks

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

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

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class GlobalBatchMgrSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class GlobalBatchMgr:
@property
def on_ssl_server_authentication() -> Callable[[GlobalBatchMgrSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[GlobalBatchMgrSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

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

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

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class GlobalBatchMgrSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class GlobalBatchMgr:
@property
def on_ssl_status() -> Callable[[GlobalBatchMgrSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[GlobalBatchMgrSSLStatusEventParams], None]) -> None: ...

Remarks

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

on_status Event

Shows the progress of the Global Payments connection.

Syntax

class GlobalBatchMgrStatusEventParams(object):
  @property
  def message() -> str: ...

# In class GlobalBatchMgr:
@property
def on_status() -> Callable[[GlobalBatchMgrStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[GlobalBatchMgrStatusEventParams], None]) -> None: ...

Remarks

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

GlobalBatchMgr Config Settings

GlobalBatchMgr Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

GlobalBatchMgr Errors

GlobalBatchMgr Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors