GlobalDebit Class

Properties   Methods   Events   Config Settings   Errors  

The GlobalDebit class is used to authorize debit card transactions with the Global Payments system, using the Global Transport Direct API. This class is supported in the Retail and Restaurant environments, and allows for simple, direct, secure communication to the Global Transport gateway through a standard Internet connection. This class can be integrated into Point Of Sale applications. Because all TLS/SSL communications are handled inside the class, any application can be deployed without the need for expensive dedicated TLS/SSL servers.

Syntax

class dpaymentssdk.GlobalDebit

Remarks

The GlobalDebit class contains a subset of the GlobalCharge class's functionality. It only authorizes debit card transactions in the Retail and Restaurant industries. It cannot be used for eCommerce accounts. This class provides a much simpler interface for processing debit cards (and only debit cards), but otherwise works much like the GlobalCharge class.

First, set the user_id and password with your login information. If you're submitting test transactions and are using a test account, set the server to the certification URL ("https://certapia.globalpay.com").

Next, set the card_magnetic_stripe property with Track 2 data read off the card. PIN-based Debit card transactions cannot be manually entered, and are always card-present transactions. Sending Track 1 data in the card_magnetic_stripe property will result in a failed transaction. You must also set the ksn and encrypted_pin properties with data retrieved from the PIN pad after the customer enters their PIN.

Finally, set the transaction_amount and if applicable, any cash_back amount. Then call sale to send the transaction to the Global Transport server for processing.

The status of the authorization request will be stored in the response_code property, with human- readable text appearing in the response_text property. There are several other Response properties which will contain data that should be logged.

Debit card transactions are instant funds transfers. There is no block placed on the debit card, funds are immediately removed and sent to the merchant. Therefore, there is no ability to capture, void, or reverse debit transactions. You must use the refund method to return funds to a customer's card. When performing a Refund, the card_magnetic_stripe, encrypted_pin, and ksn are required in addition to the PNRef parameter, which identifies the transaction you're issuing a refund for.

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

Type of credit card being used in this transaction.

Syntax

def get_card_type() -> int: ...
def set_card_type(value: int) -> None: ...

card_type = property(get_card_type, set_card_type)

Default Value

0

Remarks

Type of credit card being used in this transaction. This property contains the customer's credit card type. This is automatically computed after the card_number is set, but it can also be changed manually. A list of valid card types is included below.

card_cvv_data Property

Three digit security code on back of card (optional).

Syntax

def get_card_cvv_data() -> str: ...
def set_card_cvv_data(value: str) -> None: ...

card_cvv_data = property(get_card_cvv_data, set_card_cvv_data)

Default Value

""

Remarks

Three digit security code on back of card (optional).

This alphanumeric property contains the three digit Visa "Card Verification Value" (CVV), MasterCard "Card Verification Code" (CVC), or four-digit American Express "Card Identification Number" (CID). This value appears as additional characters embossed on the card signature line following the credit card account number on the back of the credit card. This is an optional property which can be used to determine if the customer is actually in possession of the credit card.

Even if the card_cvv_data is incorrect, the transaction may still be authorized. It is up to the merchant to examine the ResponseCVVResult property and decide whether to honor the transaction or not.

Note: When set to a non-empty value, card_cvv_presence will be automatically set to cvpProvided. If set to empty string (""), card_cvv_presence will be automatically set to cvpNotProvided.

card_cvv_presence Property

Indicates the presence of the card verification value.

Syntax

def get_card_cvv_presence() -> int: ...
def set_card_cvv_presence(value: int) -> None: ...

card_cvv_presence = property(get_card_cvv_presence, set_card_cvv_presence)

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of card_cvv_data.

The class will automatically set this value to cvpProvided when a card_cvv_data value is specified. You can explicitly specify the card_cvv_presence indicator by setting this property.

Available values are:

• cvpNotProvided (0)
• cvpProvided (1)
• cvpIllegible (2)
• cvpNotOnCard (3)

card_entry_data_source Property

This property contains a 1-character code identifying the source of the customer data.

Syntax

def get_card_entry_data_source() -> int: ...
def set_card_entry_data_source(value: int) -> None: ...

card_entry_data_source = property(get_card_entry_data_source, set_card_entry_data_source)

Default Value

0

Remarks

This property contains a 1-character code identifying the source of the customer data. The table below shows all supported values for this property.

Below is a list of processors and their support EntryDataSource values:

FDMS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable, edsIVR, edsKiosk

FDMSOmaha - All EntryDataSources applicable

FDMS Rapid Connect - All EntryDataSources applicable

Global - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsIVR, edsKiosk

PTech - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack1Contactless, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYS - edsTrack1, edsTrack2, edsManualEntryTrack1Capable, edsManualEntryTrack2Capable, edsManualEntryNoCardReader, edsTrack2Contactless, edsManualEntryContactlessCapable

TSYSHC - Values are based on Industry type.

card_exp_month Property

Expiration month of the credit card specified in Number .

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

Expiration month of the credit card specified in card_number.

This property contains the expiration date of the customer's credit card, and must be in the range 1 - 12.

card_exp_year Property

Expiration year of the credit card specified in Number .

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

2000

Remarks

Expiration year of the credit card specified in card_number.

This property contains the expiration date of the customer's credit card. This property must be in the range 0 - 99, or 2000 - 2099. Any date before the year 2000 or after 2099 cannot be specified.

card_is_encrypted Property

Determines whether data set to the Number or MagneticStripe properties is validated.

Syntax

def get_card_is_encrypted() -> bool: ...
def set_card_is_encrypted(value: bool) -> None: ...

card_is_encrypted = property(get_card_is_encrypted, set_card_is_encrypted)

Default Value

FALSE

Remarks

Determines whether data set to the card_number or card_magnetic_stripe fields is validated.

By default, when the card_number or card_magnetic_stripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and card_magnetic_stripe data will be parsed for the track specified by card_entry_data_source. However, any other non-numerical data entered will cause an exception to be thrown. It may be useful in some gateways to send other data in the card_number or card_magnetic_stripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the card_type may be affected, and the card number will not be verified.

card_magnetic_stripe Property

Track data read off of the card's magnetic stripe.

Syntax

def get_card_magnetic_stripe() -> str: ...
def set_card_magnetic_stripe(value: str) -> None: ...

card_magnetic_stripe = property(get_card_magnetic_stripe, set_card_magnetic_stripe)

Default Value

""

Remarks

Track data read off of the card's magnetic stripe.

If card_entry_data_source is not one of the manually entered enumerations, then this property must be set with the track1 or track2 data from the magnetic stripe on the back of the customer's credit card. This includes everything after but not including the start sentinel (% or ;) and up to but not including the end sentinel (?) and LRC check character. You may only set this property with track 1 or track 2 data, and may not pass both. Use the card_entry_data_source property to indicate which track you are sending.

The following example shows how to set the card_magnetic_stripe and card_entry_data_source properties if the data read off the card is "%B4788250000028291^TSYS^05121015432112345678?;4788250000028291=05121015432112345678?"

class.CardMagneticStripe = "B4788250000028291^TSYS^05121015432112345678" class.CardEntryDataSource = edsTrack1 or class.CardMagneticStripe = "4788250000028291=05121015432112345678" class.CardEntryDataSource = edsTrack2

Industry regulations do not allow merchants or processors to store track data in any form of persistent storage. Failure to abide by this regulation can result in significant fines and other penalties.

card_number Property

Customer's credit card number for the transaction.

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

Customer's credit card number for the transaction.

If you're sending the transaction with card_magnetic_stripe data, this property should be left empty.

cash_back Property

Optional cash back amount to return to the customer.

Syntax

def get_cash_back() -> str: ...
def set_cash_back(value: str) -> None: ...

cash_back = property(get_cash_back, set_cash_back)

Default Value

""

Remarks

For cash back transactions, the transaction_amount must contain the sum total of the purchase amount PLUS the cash_back amount. If the purchase is for $10 and the customer requests $20 cash back, cash_back should be set to "20.00" and transaction_amount must contain "30.00". This amount is to be specified in US dollars, without a dollar sign but with an explicit decimal point. For instance, ten dollars and fifty cents is to be specified as "10.50".

Note that only US currency is supported for debit and EBT cash benefit transactions.

customer_name Property

The cardholder's name as it appears on the card.

Syntax

def get_customer_name() -> str: ...
def set_customer_name(value: str) -> None: ...

customer_name = property(get_customer_name, set_customer_name)

Default Value

""

Remarks

This optional field may contain up to 26 alphanumeric characters and symbols.

encrypted_pin Property

DUKPT DES encrypted pin block, retrieved from a PIN pad.

Syntax

def get_encrypted_pin() -> str: ...
def set_encrypted_pin(value: str) -> None: ...

encrypted_pin = property(get_encrypted_pin, set_encrypted_pin)

Default Value

""

Remarks

A 16-byte encrypted PIN and associated ksn (Key Serial/Sequence Number) are required for all debit sale and refund transactions. These values must be retrieved from a certified DUKPT DES pin pad device.

Debit transactions are only supported for Retail merchants, and only for Card Present transactions. If you set the user_id to an ID associated with a Direct Marketing or E-Commerce merchant account, or otherwise attempt a card-not-present transaction, the class fails with an error.

class.UserId = "4dpayments_retail" class.Password = "Passw0rd" class.CardMagneticStripe = "9999999800002773=05121015432112345678" class.CardEntryDataSource = edsMagneticStripe class.TransactionAmount = "25.00" class.EncryptedPIN = "623F36B53CC18393" class.KSN = "000000008F000021" class.CashBack = "5.00" class.Sale()

invoice_number Property

Optional invoice tracking number.

Syntax

def get_invoice_number() -> str: ...
def set_invoice_number(value: str) -> None: ...

invoice_number = property(get_invoice_number, set_invoice_number)

Default Value

""

Remarks

The maximum length for American Express cards is 16 characters, and 25 characters for all other card types. This property is required for the lowest rate on keyed transactions.

ksn Property

Clear-text Key Serial Number retrieved from a PIN pad.

Syntax

def get_ksn() -> str: ...
def set_ksn(value: str) -> None: ...

ksn = property(get_ksn, set_ksn)

Default Value

""

Remarks

A 16-byte Key Serial/Sequence Number (KSN) and associated encrypted_pin are required for all debit sale and credit transactions. These values must be retrieved from a certified DUKPT DES pin pad device. The exact length of the Key Serial Number is 16 digits. If the PIN pad returns a 20 digit Key Serial Number and the first four characters are "FFFF", the class will internally strip the "FFFF" prior to passing the Key Serial Number to the Global Transport Gateway.

Debit transactions are only supported for Retail merchants, and only for Card Present transactions. If you set the user_id to an ID associated with a Direct Marketing or E-Commerce merchant account, or otherwise attempt a card-not-present transaction, the class fails with an error.

class.UserId = "4dpayments_retail" class.Password = "Passw0rd" class.CardMagneticStripe = "9999999800002773=05121015432112345678" class.CardEntryDataSource = edsMagneticStripe class.TransactionAmount = "25.00" class.EncryptedPIN = "623F36B53CC18393" class.KSN = "000000008F000021" class.CashBack = "5.00" class.Sale()

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.

register_number Property

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

Syntax

def get_register_number() -> str: ...
def set_register_number(value: str) -> None: ...

register_number = property(get_register_number, set_register_number)

Default Value

""

Remarks

This may be up to 10 alphanumeric characters in length.

response_approval_code Property

Contains the transaction authorization code from the card issuer.

Syntax

def get_response_approval_code() -> str: ...

response_approval_code = property(get_response_approval_code, None)

Default Value

""

Remarks

Contains the transaction authorization code from the card issuer.

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

This property is read-only.

response_batch_number Property

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

Syntax

def get_response_batch_number() -> str: ...

response_batch_number = property(get_response_batch_number, None)

Default Value

""

Remarks

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

This property is read-only.

response_card_type Property

Indicates the card type or payment method.

Syntax

def get_response_card_type() -> str: ...

response_card_type = property(get_response_card_type, None)

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".

This property is read-only.

response_code Property

Contains the transaction result code from the Global Transport Gateway.

Syntax

def get_response_code() -> str: ...

response_code = property(get_response_code, None)

Default Value

""

Remarks

Contains the transaction result code from the Global Transport Gateway. This value signifies the result of the transaction (i.e. approved, declined, etc). When programmatically validating a transaction's result, this value should ALWAYS be used instead of any response message describing the result. See the table below for a full list of result codes and descriptions.

A Partial Authorization transaction occurs when the issuer authorizes part of the sale amount on a pre-paid credit card. The transaction is approved for an amount less than the original TransactionAmount, and the customer must tender the remaining balance with another form of payment. When a transaction is partially approved, the response_code will contain "200", the response_message will contain "Partial Approval", and the response_message_detail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the response_authorized_amount will contain the amount of the transaction that was authorized, and the response_balance_due property will indicate the amount still owed by the customer.

If a partial authorization occurs and the customer does not wish to go through with the transaction, you must submit a reversal of the authorization in order to return funds to the prepaid card.

This property is read-only.

response_data Property

Contains the raw response data from the Global Payments host.

Syntax

def get_response_data() -> str: ...

response_data = property(get_response_data, None)

Default Value

""

Remarks

Contains the raw response data from the Global Payments host.

This property is read-only.

response_host_code Property

Action code returned by Global Payments.

Syntax

def get_response_host_code() -> str: ...

response_host_code = property(get_response_host_code, None)

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 response_host_code will indicate the reason for the decline. The table below lists the possible response_host_code and response_message combinations for error conditions.

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

This property is read-only.

response_invoice_number Property

Contains the same invoice number for the transaction that was originally sent in the request to the Global Transport Gateway.

Syntax

def get_response_invoice_number() -> str: ...

response_invoice_number = property(get_response_invoice_number, None)

Default Value

""

Remarks

Contains the same invoice number for the transaction that was originally sent in the request to the Global Transport Gateway. This field has a maximum length of 25 alphanumeric characters.

This property is read-only.

response_merchant_code Property

Merchant Id code which must be printed on all receipts.

Syntax

def get_response_merchant_code() -> str: ...

response_merchant_code = property(get_response_merchant_code, None)

Default Value

""

Remarks

Merchant Id code which must be printed on all receipts.

This property will contain a 15-character code that identifies the merchant on the Global Payments host.

This property is read-only.

response_message Property

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

Syntax

def get_response_message() -> str: ...

response_message = property(get_response_message, None)

Default Value

""

Remarks

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

This value is typically either Approved or Declined, but may also contain a description of any error condition. Do NOT use this when programmatically validating a transaction's result; use the response_code property instead.

This property is read-only.

response_message_detail Property

Contains a formatted response message concerning the processed transaction.

Syntax

def get_response_message_detail() -> str: ...

response_message_detail = property(get_response_message_detail, None)

Default Value

""

Remarks

Contains a formatted response message concerning the processed transaction. This property will contain an additional message about the results of the transaction, providing more detail than the response_message property alone. For approved transactions this property will typically be "APPROVAL", and for declined transactions will contain a detailed error message. Do NOT use this when programmatically validating a transaction's result; Use the response_code property instead.

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

This property is read-only.

response_pn_ref Property

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

Syntax

def get_response_pn_ref() -> str: ...

response_pn_ref = property(get_response_pn_ref, None)

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.

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.

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.

transaction_amount Property

Amount to be charged from (or refunded to) the card.

Syntax

def get_transaction_amount() -> str: ...
def set_transaction_amount(value: str) -> None: ...

transaction_amount = property(get_transaction_amount, set_transaction_amount)

Default Value

""

Remarks

This is required for sale and refund transactions. The transaction amount may be up to 11 characters in length, and must be in the format "DDDDDDDD.CC", and be left-justified with no fill (eg: "1.99"). This must always be a positive, non-zero value.

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.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

refund Method

Refunds a previous transaction.

Syntax

def refund(pn_ref: str) -> None: ...

Remarks

This method issues a refund based on a previously authorized sale transaction.

Debit card transactions are instant funds transfers. There is no block placed on the debit card, funds are immediately removed and sent to the merchant. Therefore, there is no ability to capture, void, or reverse debit transactions. You must use the refund method to return funds to a customer's card. When performing a Refund, the card_magnetic_stripe, encrypted_pin, and ksn are required in addition to the PNRef parameter, which identifies the transaction you're issuing a refund for.

To process a refund, set card_magnetic_stripe, encrypted_pin, and ksn then call refund with the PNRef parameter set to the PNRef returned in response from the transaction for which you wish to issue a refund. If you leave the transaction_amount blank, the full amount of the original transaction will be refunded. However, you may issue a partial refund for any value up to the original sale amount. For example:

Full Refund: class.CardMagneticStripe = "9999999800002773=05121015432112345678" class.CardEntryDataSource = edsMagneticStripe class.EncryptedPIN = "623F36B53CC18393" class.KSN = "000000008F000021" class.Refund("123456"); // "123456" is the PNRef from the original transaction Partial Refund: class.CardMagneticStripe = "9999999800002773=05121015432112345678" class.CardEntryDataSource = edsMagneticStripe class.EncryptedPIN = "623F36B53CC18393" class.KSN = "000000008F000021" class.TransactionAmount = "15.00"; // Original transaction was for $25.00, so this is a partial refund class.Refund("123456"); // "123456" is the PNRef from the original transaction

Note: Partial refunds are supported regardless of the time and date or batch status (open or closed). To perform a partial refund, pass any transaction_amount that is less than the original transaction amount to the refund transaction as per the example above.

reset Method

Clears all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

This method clears all properties to their default values.

sale Method

Sends a Sale transaction to the host.

Syntax

def sale() -> None: ...

Remarks

A basic Sale transaction. This transaction immediately transfers the funds from the cardholders account. This transaction is automatically added to the current open batch, and will be settled after the current batch is settled. The batch settlement may be set up to occur automatically, or you can control when the batch settles with the GlobalBatchMgr class.

Debit card transactions are instant funds transfers. There is no block placed on the debit card, funds are immediately removed and sent to the merchant. Therefore, there is no ability to capture, void, or reverse debit transactions. You must use the refund method to return funds to a customer's card. When performing a Refund, the card_magnetic_stripe, encrypted_pin, and ksn are required in addition to the PNRef parameter, which identifies the transaction you're issuing a refund for.

To perform a sale, set the card_magnetic_stripe property with Track 2 data read off the card. PIN-based Debit card transactions cannot be manually entered, and are always card-present transactions. Sending Track 1 data in the card_magnetic_stripe property will result in a failed transaction. You must also set the ksn and encrypted_pin properties with data retrieved from the PIN pad after the customer enters their PIN. For example:

Sale transaction with Track 2 data: class.CardEntryDataSource = edsMagneticStripe class.CardMagneticStripe = "4003000123456781=15125025432198712345" class.EncryptedPIN = "7F8A30DB967DAB4D" class.KSN = "3D01000042000007" class.CashBack="5.00" class.TransactionAmount = "10.00" //Total including CashBack class.Sale()

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

# In class GlobalDebit:
@property
def on_error() -> Callable[[GlobalDebitErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[GlobalDebitErrorEventParams], 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 GlobalDebitSSLServerAuthenticationEventParams(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 GlobalDebit:
@property
def on_ssl_server_authentication() -> Callable[[GlobalDebitSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[GlobalDebitSSLServerAuthenticationEventParams], 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 GlobalDebitSSLStatusEventParams(object):
  @property
  def message() -> str: ...

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

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

Remarks

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

GlobalDebit Config Settings

GlobalDebit 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

GlobalDebit Errors

GlobalDebit 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