GlobalCardValidator Class

Properties   Methods   Events   Config Settings   Errors  

The GlobalCardValidator class is used to verify with Global Payments that a given card number is formatted properly, and could be a valid card number. Validating a card before actually submitting a transaction for authorization can reduce the fees that may be associated with invalid or declined transactions.

Syntax

class dpaymentssdk.GlobalCardValidator

Remarks

Utilization of this class catches accidentally mistyped card numbers and allows buyers to re-input their number without having the transaction declined. It can also determine the type of credit card (Visa, MasterCard, Discover, etc) so that you can easily determine if the customer is presenting a payment type which you do not support. The class can also parse swiped track data and perform these same checks on it.

There are four checks performed by the validate_card method on the customer's credit card information:

• The card number is checked for validity using the Luhn mod-10 algorithm.
• The type of the card (Visa, MasterCard, etc.) is computed from the card number.
• The expiration date is checked against the current system date.
• The length of the card number is checked to see if it's a valid length for the computed card type.

In addition, the is_commercial_card method will attempt to determine if the specified card_number is a commercial or purchasing card, and the get_debit_network_info method will attempt to determine if the card_number is a debit card. This way you can pass Level 2 data (Tax amount and purchase order number) for commercial cards, or ask for a PIN for debit cards, and receive a lower interchange rate for the transaction.

This class will query the Global Transport server to perform the above checks. The user_id and password is only required for the get_debit_network_info method, neither is_commercial_card or validate_card require authentication to use. The first three checks made by the validate_card method may also be performed off-line by setting the ValidationMode configuration setting to "Local" instead of "Global". In this case, the mod-10 check will be computed mathematically by the class, and the expiration date will be checked against the current system time. The card_type_description will be computed using an internal set of rules, but do note that these will not be as up-to-date as the rules the Global Payments server uses. The length check will only be performed when ValidationMode is set to "Global" mode.

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.

card_exp_month Property

Expiration month of the card specified in CardNumber .

Syntax

def get_card_exp_month() -> int: ...
def set_card_exp_month(value: int) -> None: ...

card_exp_month = property(get_card_exp_month, set_card_exp_month)

Default Value

1

Remarks

This field contains the month portion of the expiration date of the customer's card. This property must be in the range 1 - 12. The validate_card method compares this property against the system time to determine if the card is expired.

card_exp_year Property

Expiration month of the card specified in CardNumber .

Syntax

def get_card_exp_year() -> int: ...
def set_card_exp_year(value: int) -> None: ...

card_exp_year = property(get_card_exp_year, set_card_exp_year)

Default Value

0

Remarks

This field contains the year portion of the expiration date of the customer's card. This property must be in the range 00-99, or 2000-2099. The validate_card method compares this property against the system time to determine if the card is expired.

card_number Property

Card number to be validated.

Syntax

def get_card_number() -> str: ...
def set_card_number(value: str) -> None: ...

card_number = property(get_card_number, set_card_number)

Default Value

""

Remarks

This property contains the customer's card number. A card number may be of any length, and may optionally include dashes or spaces. However, in practice the maximum length of the supported card_types is 19 characters (excluding whitespace), and the minimum length is 13 characters.

card_type Property

Indicates the results of the Luhn Digit Check algorithm.

Syntax

def get_card_type() -> int: ...

card_type = property(get_card_type, None)

Default Value

0

Remarks

This property is filled after a call to the validate_card method. Allowable values include:

Note that this integer value is computed by the class, the actual value returned from the Global Transport server will be contained in card_type_description.

This property is read-only.

card_type_description Property

Human-readable description of the CardType .

Syntax

def get_card_type_description() -> str: ...

card_type_description = property(get_card_type_description, None)

Default Value

""

Remarks

This property is filled after calling the validate_card method, and will contain a text description of the card_type. This is useful to distinguish different program cards. For instance, a card_type of ccDiners might have a corresponding card_type_description of "Diner's Club International", "Diner's Club Carte Blanche", or "Diner's Club enRoute".

Note that this property will contain the exact text returned by the Global Transport server.

This property is read-only.

date_check_passed Property

Indicates whether the card is expired or not.

Syntax

def get_date_check_passed() -> bool: ...

date_check_passed = property(get_date_check_passed, None)

Default Value

FALSE

Remarks

The validate_card method checks whether the card's expiration date (card_exp_month and card_exp_year) is a valid future date, and stores that result in the date_check_passed property.

This property is read-only.

digit_check_passed Property

Indicates the results of the Luhn Digit Check algorithm.

Syntax

def get_digit_check_passed() -> bool: ...

digit_check_passed = property(get_digit_check_passed, None)

Default Value

FALSE

Remarks

The validate_card method checks whether or not the card_number conforms to the mod-10 digit check algorithm, and stores that result in the digit_check_passed property. Note that a card may pass this check and still be an invalid card. (Either a fake number that passes the digit check, or an unknown card_type).

This property is read-only.

length_check_passed Property

Indicates the results of the card number length check.

Syntax

def get_length_check_passed() -> bool: ...

length_check_passed = property(get_length_check_passed, None)

Default Value

FALSE

Remarks

The validate_card method checks whether or not the card_number's length is appropriate for the card's prefix, and stores that result in the length_check_passed property. Note that a card may pass this check and still be an invalid card. (For instance, a fake number that passes the length check).

This property is read-only.

network_info_authorizer_number Property

Two-digit code that identifies the debit network.

Syntax

def get_network_info_authorizer_number() -> str: ...

network_info_authorizer_number = property(get_network_info_authorizer_number, None)

Default Value

""

Remarks

Two-digit code that identifies the debit network. The network_info_network_name network_info_network_id and network_info_authorizer_number properties are used to identify the debit network to which the card belongs. The current list of available networks is shown below:

This property will be blank if the card number you're validating does not belong to a debit card.

This property is read-only.

network_info_code Property

Contains the transaction result code from the Global Transport Gateway.

Syntax

def get_network_info_code() -> str: ...

network_info_code = property(get_network_info_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 network_info_code will contain "200", the network_info_message will contain "Partial Approval", and the network_info_message_detail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the network_info_authorized_amount will contain the amount of the transaction that was authorized, and the network_info_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.

network_info_id Property

Identification code for the debit network.

Syntax

def get_network_info_id() -> str: ...

network_info_id = property(get_network_info_id, None)

Default Value

""

Remarks

Identification code for the debit network. The network_info_network_name network_info_network_id and network_info_authorizer_number properties are used to identify the debit network to which the card belongs. The current list of available networks is shown below:

This property will be blank if the card number you're validating does not belong to a debit card.

This property is read-only.

network_info_name Property

Name of the debit network.

Syntax

def get_network_info_name() -> str: ...

network_info_name = property(get_network_info_name, None)

Default Value

""

Remarks

Name of the debit network. The network_info_network_name network_info_network_id and network_info_authorizer_number properties are used to identify the debit network to which the card belongs. The current list of available networks is shown below:

This property will be blank if the card number you're validating does not belong to a debit card.

This property is read-only.

network_info_offline_supported Property

Indicates whether offline transactions are supported for the debit network.

Syntax

def get_network_info_offline_supported() -> bool: ...

network_info_offline_supported = property(get_network_info_offline_supported, None)

Default Value

FALSE

Remarks

Indicates whether offline transactions are supported for the debit network.

This property is read-only.

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.

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.

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.

track_data Property

Magnetic stripe data read off the card.

Syntax

def get_track_data() -> str: ...
def set_track_data(value: str) -> None: ...

track_data = property(get_track_data, set_track_data)

Default Value

""

Remarks

This property may be set with the magnetic stripe read off the back of a card using any commercially available card reader. You may set this property with either Track1 or Track2 data. If track_data is set, the values contained in card_number, card_exp_month, and card_exp_year are ignored when calling validate_card. Instead, these properties are parsed out of the track data. This allows you to easily retrieve the expiration date and card number from either Track1 or Track2 data. For instance:

CardValidator1.TrackData = "4012000033330026=09121015432112345678" CardValidator1.ValidateCard()

The card_number, card_exp_month, and card_exp_year will now contain the values parsed from the track data. track_type will also indicate whether the track_data is Track1 or Track2 (in this case, it's Track2 data).

track_type Property

Indicates the type of the specified TrackData .

Syntax

def get_track_type() -> int: ...

track_type = property(get_track_type, None)

Default Value

0

Remarks

This property will be filled after a call to validate_card. If magnetic stripe data was supplied in the track_data field, this property will indicate which type of track was entered. If no track data was entered (ie, the card_number was specified instead) then the track_type will be ttUnknown.

This property is read-only.

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.

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

Determines if the card is a debit card, and which network it belongs to.

Syntax

def get_debit_network_info() -> None: ...

Remarks

This method retrieves the name, Id, and Authorizer number of the U.S. Debit Network, if the card_number matches a debit network's BIN range. The possible networks are detailed in the table below. If there is a match, the card can likely be processed through the U.S. debit network as a PIN-based debit transaction.

If the card_number is not a debit card or there is an error communicating with Global Payments, an error code will be stored in the network_info_code property, and a detailed error message will be contained in the network_info_name property.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

is_commercial_card Method

Indicates whether or not the CardNumber is for a commercial/purchasing card.

Syntax

def is_commercial_card() -> bool: ...

Remarks

This method queries the Global Payments servers as to whether or not the credit card number specified by card_number is a commercial card. The Global Payments server compares the card prefix against the latest BIN ranges to determine this. However, please note that due to the dynamic nature of card BIN ranges, not all Commercial/Purchasing cards can be determined by this method. Developers should keep this in mind when designing applications.

The card_number is the only property required for this method. If the card_number does fall within a Commercial or Purchasing card BIN range, the is_commercial_card method will return True. If it is not - or if the transaction fails, this method will return False.

reset Method

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

This method clears all properties to their default values.

validate_card Method

Checks the card number and expiration date for validity.

Syntax

def validate_card() -> None: ...

Remarks

This method performs several checks on customer information to determine if the card information submitted could be valid. This should be done before submitting an actual transaction for authorization. The tests performed are listed below:

This class will query the Global Transport server to perform the above checks. The user_id and password is only required for the get_debit_network_info method, neither is_commercial_card or validate_card require authentication to use. The first three checks made by the validate_card method may also be performed off-line by setting the ValidationMode configuration setting to "Local" instead of "Global". In this case, the mod-10 check will be computed mathematically by the class, and the expiration date will be checked against the current system time. The card_type_description will be computed using an internal set of rules, but do note that these will not be as up-to-date as the rules the Global Payments server uses. The length check will only be performed when ValidationMode is set to "Global" mode.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

# In class GlobalCardValidator:
@property
def on_error() -> Callable[[GlobalCardValidatorErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[GlobalCardValidatorErrorEventParams], 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 GlobalCardValidatorSSLServerAuthenticationEventParams(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 GlobalCardValidator:
@property
def on_ssl_server_authentication() -> Callable[[GlobalCardValidatorSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[GlobalCardValidatorSSLServerAuthenticationEventParams], 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 GlobalCardValidatorSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

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

Remarks

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

GlobalCardValidator Config Settings

GlobalCardValidator 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

GlobalCardValidator Errors

GlobalCardValidator 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