GlobalTransactionSearch Class

Properties   Methods   Events   Config Settings   Errors  

The GlobalTransactionSearch class is used to search for transactions made using the Global Transport Direct API. It can search for transactions in the open batch or in any previously closed batch.

Syntax

class dpaymentssdk.GlobalTransactionSearch

Remarks

This class can be used to search for all the transactions made from your Global Payments account, and returns transactions that match your specified search_criteria. To do a search, first set your user_id, password, and vendor_number. If you're submitting test transactions and are using a test account, set the server to the certification URL ("https://certapia.globalpay.com"). Now set the search_criteria to the transactions you're looking for, and call search. At the minimum, you must specify a start and end date range in the search_begin_date and search_end_date properties. All other search criteria properties are optional. However, if you wish to retrieve information for one particular transaction, set the search_pn_ref property instead. All other properties will be ignored if the search_pn_ref property is set. The results of your search will be contained in the search_results collection.

This class can also return a transaction summary for all transactions that match your search_criteria by calling the get_transaction_summary method. The search_begin_date and search_end_date are still required for transaction summaries, but only a subset of search_criteria properties may be used to restrict the results. See get_transaction_summary for details.

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.

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.

search_approval_code Property

If provided, only those transactions matching the specified ApprovalCode will be included in the search results.

Syntax

def get_search_approval_code() -> str: ...
def set_search_approval_code(value: str) -> None: ...

search_approval_code = property(get_search_approval_code, set_search_approval_code)

Default Value

""

Remarks

If provided, only those transactions matching the specified ApprovalCode will be included in the search results. This property may contain up to 6 alphanumeric characters and symbols.

search_begin_date Property

The start of the date range in which to search for transactions.

Syntax

def get_search_begin_date() -> str: ...
def set_search_begin_date(value: str) -> None: ...

search_begin_date = property(get_search_begin_date, set_search_begin_date)

Default Value

""

Remarks

The start of the date range in which to search for transactions. This property is required except when the search_pn_ref property is provided. It may contain up to 19 alphanumeric characters and symbols. The search_begin_date of the date range may be in MM/DD/YYYY (or YYYY-MMDD or YYYY-MM-DDThh:mm:ss) format. This date will be converted by the Global Payments system to YYYYMM- DDThh:mm:ss (time is in 24-hour format). If the value set in search_begin_date does not contain time information, it will default to midnight on the given date.

search_card_number Property

If specified, only those transactions with the matching card number will be included in the search result.

Syntax

def get_search_card_number() -> str: ...
def set_search_card_number(value: str) -> None: ...

search_card_number = property(get_search_card_number, set_search_card_number)

Default Value

""

Remarks

If specified, only those transactions with the matching card number will be included in the search result. Wildcards may be used in this property.

search_card_type Property

If specified, only transactions made with the matching the CardType will be included in the search results.

Syntax

def get_search_card_type() -> str: ...
def set_search_card_type(value: str) -> None: ...

search_card_type = property(get_search_card_type, set_search_card_type)

Default Value

""

Remarks

If specified, only transactions made with the matching the CardType will be included in the search results. Valid values include:

search_customer_id Property

The CustomerId included in the original transaction.

Syntax

def get_search_customer_id() -> str: ...
def set_search_customer_id(value: str) -> None: ...

search_customer_id = property(get_search_customer_id, set_search_customer_id)

Default Value

""

Remarks

The CustomerId included in the original transaction. If provided, only those transactions made by the matching customer will be included in the search results.

This property is not applicable for Transaction Summaries.

search_end_date Property

The end of the date range in which to search for transactions.

Syntax

def get_search_end_date() -> str: ...
def set_search_end_date(value: str) -> None: ...

search_end_date = property(get_search_end_date, set_search_end_date)

Default Value

""

Remarks

The end of the date range in which to search for transactions. This property is required except when the search_pn_ref property is provided. It may contain up to 19 alphanumeric characters and symbols. The search_end_date of the date range may be in MM/DD/YYYY (or YYYY-MMDD or YYYY-MM-DDThh:mm:ss) format. This date will be converted by the Global Payment system to YYYYMM- DDThh:mm:ss (time is in 24-hour format). If the value set in search_end_date does not contain time information, it will be incremented to the next day at midnight such that no transaction on the desired end date will be excluded based on its time.

search_exclude_card_type Property

If specified, any transaction made with a credit card matching the ExcludeCardType will be excluded from the search results.

Syntax

def get_search_exclude_card_type() -> str: ...
def set_search_exclude_card_type(value: str) -> None: ...

search_exclude_card_type = property(get_search_exclude_card_type, set_search_exclude_card_type)

Default Value

""

Remarks

If specified, any transaction made with a credit card matching the ExcludeCardType will be excluded from the search results. Valid values include:

This property is not applicable for Transaction Summaries.

search_exclude_payment_type Property

If specified, any transaction matching the ExcludePaymentType will be excluded from the search results.

Syntax

def get_search_exclude_payment_type() -> str: ...
def set_search_exclude_payment_type(value: str) -> None: ...

search_exclude_payment_type = property(get_search_exclude_payment_type, set_search_exclude_payment_type)

Default Value

""

Remarks

If specified, any transaction matching the ExcludePaymentType will be excluded from the search results. Valid values include:

This property is not applicable for Transaction Summaries.

search_exclude_response_code Property

If specified, any transactions matching the ExcludeResponseCode will be excluded from the search results.

Syntax

def get_search_exclude_response_code() -> str: ...
def set_search_exclude_response_code(value: str) -> None: ...

search_exclude_response_code = property(get_search_exclude_response_code, set_search_exclude_response_code)

Default Value

""

Remarks

If specified, any transactions matching the ExcludeResponseCode will be excluded from the search results. For instance, to exclude all approved transactions and return only declines, set the search_exclude_response_code to "0". (As "0" is the response code for approved transactions).

This property is not applicable for Transaction Summaries.

search_exclude_trans_type Property

If specified, any transaction matching the ExcludeTransType will be excluded from the search results.

Syntax

def get_search_exclude_trans_type() -> str: ...
def set_search_exclude_trans_type(value: str) -> None: ...

search_exclude_trans_type = property(get_search_exclude_trans_type, set_search_exclude_trans_type)

Default Value

""

Remarks

If specified, any transaction matching the ExcludeTransType will be excluded from the search results. Valid values include:

This property is not applicable for Transaction Summaries.

search_exclude_void Property

Indicates whether or not to exclude void transactions from the search results.

Syntax

def get_search_exclude_void() -> bool: ...
def set_search_exclude_void(value: bool) -> None: ...

search_exclude_void = property(get_search_exclude_void, set_search_exclude_void)

Default Value

FALSE

Remarks

Indicates whether or not to exclude void transactions from the search results.

search_invoice_number Property

The InvoiceNumber that was included in the original transaction.

Syntax

def get_search_invoice_number() -> str: ...
def set_search_invoice_number(value: str) -> None: ...

search_invoice_number = property(get_search_invoice_number, set_search_invoice_number)

Default Value

""

Remarks

The InvoiceNumber that was included in the original transaction. If provided, only those transactions with matching InvoiceNumber will be included in the search results. Wildcards are allowed.

This property is not applicable for Transaction Summaries.

search_name_on_card Property

Cardholder's name as it is appears on the card.

Syntax

def get_search_name_on_card() -> str: ...
def set_search_name_on_card(value: str) -> None: ...

search_name_on_card = property(get_search_name_on_card, set_search_name_on_card)

Default Value

""

Remarks

Cardholder's name as it is appears on the card. If specified, only those transactions with the matching cardholder's name will be included in the search result. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234".

search_payment_type Property

Only transactions matching the PaymentType will be included in the search results.

Syntax

def get_search_payment_type() -> str: ...
def set_search_payment_type(value: str) -> None: ...

search_payment_type = property(get_search_payment_type, set_search_payment_type)

Default Value

""

Remarks

Only transactions matching the PaymentType will be included in the search results. Valid values include:

This property is not applicable for Transaction Summaries.

search_pn_ref Property

The unique payment reference number assigned to the transaction.

Syntax

def get_search_pn_ref() -> str: ...
def set_search_pn_ref(value: str) -> None: ...

search_pn_ref = property(get_search_pn_ref, set_search_pn_ref)

Default Value

""

Remarks

The unique payment reference number assigned to the transaction. If this property is provided all other search criteria fields will be ignored.

This property is not applicable for Transaction Summaries.

search_register_number Property

The RegisterNumber associated with the original transaction.

Syntax

def get_search_register_number() -> str: ...
def set_search_register_number(value: str) -> None: ...

search_register_number = property(get_search_register_number, set_search_register_number)

Default Value

""

Remarks

The RegisterNumber associated with the original transaction. If specified, only transactions that were sent with the matching RegisterNumber will be returned in the response. This property may contain up to 10 alphanumeric characters.

search_response_code Property

If specified, only those transactions with the matching response code will be included in the search results.

Syntax

def get_search_response_code() -> str: ...
def set_search_response_code(value: str) -> None: ...

search_response_code = property(get_search_response_code, set_search_response_code)

Default Value

""

Remarks

If specified, only those transactions with the matching response code will be included in the search results. "0" indicates an approved transaction, anything else is a decline. Note that if you want all the declined transactions you should set search_exclude_response_code to "0" (to exclude all approved transactions) instead.

This property is not applicable for Transaction Summaries.

search_settle_date Property

The date of the settlement in MM/DD/YYYY or YYYY-MMDD format.

Syntax

def get_search_settle_date() -> str: ...
def set_search_settle_date(value: str) -> None: ...

search_settle_date = property(get_search_settle_date, set_search_settle_date)

Default Value

""

Remarks

The date of the settlement in MM/DD/YYYY or YYYY-MMDD format.

search_settle_flag Property

Indicates whether you wish to retrieve settled transactions or unsettled transactions.

Syntax

def get_search_settle_flag() -> bool: ...
def set_search_settle_flag(value: bool) -> None: ...

search_settle_flag = property(get_search_settle_flag, set_search_settle_flag)

Default Value

FALSE

Remarks

Indicates whether you wish to retrieve settled transactions or unsettled transactions. If set to true, only transactions that have been settled will be returned. If set to false (default), only transactions that have not been settled will be returned.

search_settle_message Property

The settlement ID or message returned from the host.

Syntax

def get_search_settle_message() -> str: ...
def set_search_settle_message(value: str) -> None: ...

search_settle_message = property(get_search_settle_message, set_search_settle_message)

Default Value

""

Remarks

The settlement ID or message returned from the host. If specified, only transactions with a matching SettleMessage value will be returned.

search_transaction_amount Property

The original TransactionAmount of the transaction.

Syntax

def get_search_transaction_amount() -> str: ...
def set_search_transaction_amount(value: str) -> None: ...

search_transaction_amount = property(get_search_transaction_amount, set_search_transaction_amount)

Default Value

""

Remarks

The original TransactionAmount of the transaction. This may be 11 characters in DDDDDDDD.CC format, left-justified with no fill (eg: "1.99"). If specified, only transactions with a matching TransactionAmount will be returned.

This property is not applicable for Transaction Summaries.

search_transaction_type Property

If provided, only those transactions matching the TransactionType will be included.

Syntax

def get_search_transaction_type() -> str: ...
def set_search_transaction_type(value: str) -> None: ...

search_transaction_type = property(get_search_transaction_type, set_search_transaction_type)

Default Value

""

Remarks

If provided, only those transactions matching the TransactionType will be included.

Valid values when search_payment_type is 0 (Credit) are:

Valid values when search_payment_type is 1 (Debit) are:

Valid values when search_payment_type is 2 (EBT) are:

This property is not applicable for Transaction Summaries.

search_user_id Property

The user who originated the transactions.

Syntax

def get_search_user_id() -> str: ...
def set_search_user_id(value: str) -> None: ...

search_user_id = property(get_search_user_id, set_search_user_id)

Default Value

""

Remarks

The user who originated the transactions. If provided, only those transactions created by the matching User will be included in the search results. Wildcards are allowed.

search_result_count Property

The number of records in the SearchResult arrays.

Syntax

def get_search_result_count() -> int: ...

search_result_count = property(get_search_result_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• search_result_approval_code
• search_result_authorized_amount
• search_result_avs_result_code
• search_result_batch_number
• search_result_card_exp_date
• search_result_card_number
• search_result_card_present
• search_result_card_type
• search_result_cash_back_amount
• search_result_client_ip
• search_result_customer_id
• search_result_customer_street
• search_result_customer_zip
• search_result_cvv_result_code
• search_result_entry_mode
• search_result_error
• search_result_gratuity_amount
• search_result_host_code
• search_result_invoice_number
• search_result_last_modified
• search_result_name_on_card
• search_result_original_pn_ref
• search_result_payment_type
• search_result_pn_ref
• search_result_processor_id
• search_result_register_number
• search_result_reseller_key
• search_result_response_code
• search_result_response_message
• search_result_settle_date
• search_result_settle_flag
• search_result_total_amount
• search_result_transaction_date
• search_result_transaction_id
• search_result_transaction_key
• search_result_transaction_type
• search_result_user_id
• search_result_vendor_number
• search_result_void_flag

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

This property is read-only.

search_result_approval_code Property

Contains the transaction authorization code from the card issuer.

Syntax

def get_search_result_approval_code(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the transaction authorization code from the card issuer.

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

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_authorized_amount Property

In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.

Syntax

def get_search_result_authorized_amount(search_result_index: int) -> str: ...

Default Value

""

Remarks

In the case of a partially authorized transaction, this will contain the dollar amount that was actually authorized.

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 search_result_code will contain "200", the search_result_message will contain "Partial Approval", and the search_result_message_detail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the search_result_authorized_amount will contain the amount of the transaction that was authorized, and the search_result_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.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_avs_result_code Property

Contains the address verification result code from the card issuer.

Syntax

def get_search_result_avs_result_code(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the address verification result code from the card issuer.

When programmatically validating an AVS Result, this value should ALWAYS be used instead of any formatted search_result_avs_result_message describing the result. The following table lists the possible AVS result codes:

* These values are Visa specific.

** These values are returned by the Global Transport Gateway and not the issuing bank.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_batch_number Property

The number of the batch this transaction is currently contained in.

Syntax

def get_search_result_batch_number(search_result_index: int) -> str: ...

Default Value

""

Remarks

The number of the batch this transaction is currently contained in. If this is a reply to an AuthOnly transaction, the search_result_batch_number property will be blank, as auth-onlys are not added to the open batch until a Capture is performed.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_card_exp_date Property

Contains the credit card expiration date.

Syntax

def get_search_result_card_exp_date(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the credit card expiration date. Typically returned in MMYY format, but may contain up to a 10-character date string.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_card_number Property

Contains the credit card number used in the transaction.

Syntax

def get_search_result_card_number(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the credit card number used in the transaction. This property will be masked out with asterisk (*) characters except for the last four digits.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_card_present Property

Indicates whether or not this was a card-present transaction.

Syntax

def get_search_result_card_present(search_result_index: int) -> bool: ...

Default Value

FALSE

Remarks

Indicates whether or not this was a card-present transaction.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_card_type Property

Indicates the card type or payment method.

Syntax

def get_search_result_card_type(search_result_index: int) -> str: ...

Default Value

""

Remarks

Indicates the card type or payment method.

For credit card transactions, this property will contain the name of the credit card type. For instance, "VISA", "MASTERCARD", "AMEX", etc. For Debit or Electronic Benefit transactions, this property will contain "DEBIT" or "EBT".

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_cash_back_amount Property

Contains the cash back amount for a debit or EBT transaction.

Syntax

def get_search_result_cash_back_amount(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the cash back amount for a debit or EBT transaction.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_client_ip Property

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

Syntax

def get_search_result_client_ip(search_result_index: int) -> str: ...

Default Value

""

Remarks

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

Contains the IP address of the client machine from which the transaction was processed.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_customer_id Property

Identifies the customer that initiated the transaction.

Syntax

def get_search_result_customer_id(search_result_index: int) -> str: ...

Default Value

""

Remarks

Identifies the customer that initiated the transaction. This property will only contain data if the merchant has assigned identification numbers to customers.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_customer_street Property

Contains the billing street address of the credit card.

Syntax

def get_search_result_customer_street(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the billing street address of the credit card.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_customer_zip Property

Contains the billing zip code of the credit card.

Syntax

def get_search_result_customer_zip(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the billing zip code of the credit card.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_cvv_result_code Property

Contains the card verification result code from the card issuer.

Syntax

def get_search_result_cvv_result_code(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the card verification result code from the card issuer.

This value is only applicable to credit card transactions. The card verification number is typically printed on the back of the card and not embossed on the front. It is used as an extra authentication method for "card not present" transactions. When programmatically validating a CV Result, this value should ALWAYS be used instead of any formatted response message describing the result, contained in the search_result_cvv_result_message property.

The following table lists the possible result codes for this property:

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_entry_mode Property

Indicates whether the card was swiped or manually keyed.

Syntax

def get_search_result_entry_mode(search_result_index: int) -> int: ...

Default Value

0

Remarks

Indicates whether the card was swiped or manually keyed. Possible values are:

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_error Property

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

Syntax

def get_search_result_error(search_result_index: int) -> str: ...

Default Value

""

Remarks

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

Contains an error message when a problem occurred during transaction processing.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_gratuity_amount Property

Contains the tip portion of the TotalAmount .

Syntax

def get_search_result_gratuity_amount(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the tip portion of the search_result_total_amount. This is not applicable to all industries and transaction types.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_host_code Property

Action code returned by Global Payments.

Syntax

def get_search_result_host_code(search_result_index: int) -> str: ...

Default Value

""

Remarks

Action code returned by Global Payments.

Typically, if the transaction is approved, this will be the batch reference number. If the transaction is declined, the search_result_host_code will indicate the reason for the decline. The table below lists the possible search_result_host_code and search_result_message combinations for error conditions.

IMPORTANT: When programmatically validating a transaction's result, the search_result_code value should ALWAYS be used instead of any other response messages describing the result. For example, do not use search_result_host_code, search_result_message, search_result_message_detail, or any other responses, as these values may vary. This tables is included for informational purposes only.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_invoice_number Property

Contains the transactions invoice number.

Syntax

def get_search_result_invoice_number(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the transactions invoice number.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_last_modified Property

Contains the date and time on which the transaction was last modified.

Syntax

def get_search_result_last_modified(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the date and time on which the transaction was last modified.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_name_on_card Property

Contains the cardholder's name.

Syntax

def get_search_result_name_on_card(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the cardholder's name. If no name was specified in the NameOnCard property when the transaction was first authorized, this property will not be returned in a search.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_original_pn_ref Property

Contains the Global Transport Gateway PNRef on which the current transaction is based.

Syntax

def get_search_result_original_pn_ref(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the Global Transport Gateway PNRef on which the current transaction is based.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_payment_type Property

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

Syntax

def get_search_result_payment_type(search_result_index: int) -> str: ...

Default Value

""

Remarks

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

Contains the payment type of this transaction. For instance, "MasterCard", "Visa", "DEBIT", etc.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_pn_ref Property

Contains a number which uniquely identifies the transaction in the Global Transport system.

Syntax

def get_search_result_pn_ref(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains a number which uniquely identifies the transaction in the Global Transport system.

This value should be stored by the POS to enable the processing transactions based on a previous transaction. For instance, Capture, Void, Refund, TipAdjustment, etc.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_processor_id Property

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

Syntax

def get_search_result_processor_id(search_result_index: int) -> str: ...

Default Value

""

Remarks

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

Contains the name of the processing platform.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_register_number Property

A number that uniquely identifies the register or computer on which the transaction was performed.

Syntax

def get_search_result_register_number(search_result_index: int) -> str: ...

Default Value

""

Remarks

A number that uniquely identifies the register or computer on which the transaction was performed. If the RegisterNumber was not sent in the authorization, this property will be empty.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_reseller_key Property

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

Syntax

def get_search_result_reseller_key(search_result_index: int) -> str: ...

Default Value

""

Remarks

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

Contains the primary key of the Reseller table.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_response_code Property

Contains the transaction result code from the Global Transport Gateway.

Syntax

def get_search_result_response_code(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the transaction result code from the Global Transport Gateway. This value signifies the result of the transaction (i.e. approved, decline, 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.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_response_message Property

Contains a human-readable response message concerning the transaction.

Syntax

def get_search_result_response_message(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains a human-readable response message concerning the transaction.

This value is typically either "Approved" or "Declined", but may also contain a description of any error condition.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_settle_date Property

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

Syntax

def get_search_result_settle_date(search_result_index: int) -> str: ...

Default Value

""

Remarks

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

Contains the date on which the transaction was settled. This date property is in the format "YYYY-MM-DD HH:MM:SS"

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_settle_flag Property

Indicates whether or not the transaction has been settled.

Syntax

def get_search_result_settle_flag(search_result_index: int) -> bool: ...

Default Value

FALSE

Remarks

Indicates whether or not the transaction has been settled.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_total_amount Property

Contains the total amount of the transaction.

Syntax

def get_search_result_total_amount(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the total amount of the transaction. This value reflects the search_result_authorized_amount plus any search_result_gratuity_amount, less any refunded amount. This amount also may be different from the search_result_authorized_amount in the case of an AuthOnly transaction followed by a Capture transaction for a different amount.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_transaction_date Property

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

Syntax

def get_search_result_transaction_date(search_result_index: int) -> str: ...

Default Value

""

Remarks

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

Contains the date on which the transaction was first made. This date property is in the format "YYYY-MM-DD HH:MM:SS"

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_transaction_id Property

Card issuer's Transaction Reference Number.

Syntax

def get_search_result_transaction_id(search_result_index: int) -> str: ...

Default Value

""

Remarks

Card issuer's Transaction Reference Number.

This property contains a Visa Transaction Id, MasterCard BankNet Reference Number, American Express Transaction Id, or Discover STAN Id. If returned in the response, this property must be printed on the receipt. Note that this search_result_transaction_id is not used by Global Payments to reference the transaction. The search_result_pn_ref property is used to track and modify transactions made on the Global Payments system.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_transaction_key Property

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

Syntax

def get_search_result_transaction_key(search_result_index: int) -> str: ...

Default Value

""

Remarks

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

Contains the Global Transport Gateway primary key of the transaction. This is also known as the Card Info Key.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_transaction_type Property

Contains the transaction type.

Syntax

def get_search_result_transaction_type(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the transaction type. For example, "Sale", "Credit", "Void", etc.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_user_id Property

Contains the username used to process the transaction.

Syntax

def get_search_result_user_id(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains the username used to process the transaction.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_vendor_number Property

Contains a number which uniquely identifies a merchant.

Syntax

def get_search_result_vendor_number(search_result_index: int) -> str: ...

Default Value

""

Remarks

Contains a number which uniquely identifies a merchant. This is also known as the RPNum.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

search_result_void_flag Property

Indicates whether or not the transaction has been voided.

Syntax

def get_search_result_void_flag(search_result_index: int) -> bool: ...

Default Value

FALSE

Remarks

Indicates whether or not the transaction has been voided.

The search_result_index parameter specifies the index of the item in the array. The size of the array is controlled by the search_result_count property.

This property is read-only.

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.

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_count Property

The number of records in the SummaryResult arrays.

Syntax

def get_summary_count() -> int: ...

summary_count = property(get_summary_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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_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 for search and summary transactions. If you do not know your Vendor/RPNum you may log into your Global Payments virtual terminal, or simply use the GlobalBatchMgr class's check_setup method to find it.

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_transaction_summary Method

Retrieves a payment type transaction summary that matches the specified SearchCriteria .

Syntax

def get_transaction_summary() -> None: ...

Remarks

This method retrieves information about all of the past transactions which are currently stored on the Global Payments servers. These results are stored in the summary_results collection.

The search_begin_date and search_end_date are required for transaction summaries, but only the following subset of search_criteria properties may be used to restrict the results:

• SearchCriteriaBatchNumber
• search_begin_date
• SearchCriteriaCardBreakdown
• search_end_date
• search_register_number
• search_user_id

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.

search Method

Retrieves a list of payments that match the specified SearchCriteria .

Syntax

def search() -> None: ...

Remarks

This method performs a search of the Global Payments system, and looks for transactions that match your specified search_criteria. All search criteria properties are optional. To retrieve information for one particular transaction, set the search_pn_ref property. All other properties will be ignored if the search_pn_ref property is set. The results of your search will be contained in the search_results collection.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

# In class GlobalTransactionSearch:
@property
def on_error() -> Callable[[GlobalTransactionSearchErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[GlobalTransactionSearchErrorEventParams], 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 GlobalTransactionSearchSSLServerAuthenticationEventParams(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 GlobalTransactionSearch:
@property
def on_ssl_server_authentication() -> Callable[[GlobalTransactionSearchSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[GlobalTransactionSearchSSLServerAuthenticationEventParams], 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 GlobalTransactionSearchSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class GlobalTransactionSearch:
@property
def on_ssl_status() -> Callable[[GlobalTransactionSearchSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[GlobalTransactionSearchSSLStatusEventParams], 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 GlobalTransactionSearchStatusEventParams(object):
  @property
  def message() -> str: ...

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

Remarks

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

GlobalTransactionSearch Config Settings

GlobalTransactionSearch 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

GlobalTransactionSearch Errors

GlobalTransactionSearch Errors

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

HTTP 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