GlobalBenefit Class

Properties   Methods   Events   Config Settings   Errors  

The GlobalBenefit class is used to authorize Electronic Benefits Transfer (EBT) 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. An EBT transaction is similar to a Debit transaction, using a PIN and Key Sequence Number (KSN), but is used for Food Stamp or Cash Benefit programs.

Syntax

GlobalBenefit

Remarks

An EBT Card (also known as Cash Benefit Card or Food Stamp Card) works similar to a bank debit card. EBT is a special application of electronic funds transfer (EFT), or debit card technology, which takes money directly from one account and transfers it to another (credit cards, by comparison, simply record a sale for payment later).

There are just a few steps to setting up the class and sending transactions. First, set the UserId and Password, making sure that EBT transactions are allowed for your login credentials. If you're submitting test transaction and are using a test account, set the Server to the certification URL ("https://certapia.globalpay.com").

To send a transaction under normal circumstances, Track2 data should be read from the EBT card and placed in the CardMagneticStripe property. The CardEntryDataSource property should be set to edsMagneticStripe, and the EncryptedPIN and KSN properties should be filled with the encrypted PIN and key sequence number returned from your PIN pad. If the card reader is unable to read the magnetic stripe, card info may be manually added in the CardNumber, CardExpMonth, and CardExpYear properties, (and set the CardEntryDataSource property to edsManuallyEntered), but only for Food Stamp Transactions. Cash Benefit transactions may not be manually keyed.

Now simply set the TransactionAmount and call the Sale method to charge the card. You may also Refund funds back to the card (Food Stamp BenefitType only), as well as send a BalanceInquiry. Voice authorizations for Food Stamp transactions may be sent using the VoucherSale method.

The status of any of the above transactions will be stored in the ResponseCode property, with human-readable text appearing in ResponseText. Like the GlobalCharge class, there are several other Response properties which will contain data that should be logged.

EBT regulations require that all customer receipts include the last 4 digits of the CardNumber and the ResponseTransactionId, as well as the available balance for the account accessed. Balances are returned in the ResponseFoodStampBalance and ResponseCashBenefitsBalance properties.

EBT 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 EBT transactions. You must use the Refund method to return funds to a customer's card - but only for Food Stamp transactions. Cash Benefit Refund transactions are not allowed. Unlike the GlobalCharge class's Refund method, the CardMagneticStripe, EncryptedPIN, 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.

BenefitType Property (GlobalBenefit Class)

Indicates whether the EBT card is a Food Stamps card or Cash Benefits card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBenefitType();
int SetBenefitType(int iBenefitType);

Unicode (Windows)
INT GetBenefitType();
INT SetBenefitType(INT iBenefitType);

BT_CASH_BENEFITS(0), 
BT_FOOD_STAMPS(1)

int dpaymentssdk_globalbenefit_getbenefittype(void* lpObj);
int dpaymentssdk_globalbenefit_setbenefittype(void* lpObj, int iBenefitType);

int GetBenefitType();
int SetBenefitType(int iBenefitType);

Default Value

0

Remarks

Available Benefit Types include:

Data Type

Integer

CardType Property (GlobalBenefit Class)

Type of credit card being used in this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardType();
int SetCardType(int iCardType);

Unicode (Windows)
INT GetCardType();
INT SetCardType(INT iCardType);

CT_UNKNOWN(0), 
CT_VISA(1), 
CT_MASTER_CARD(2), 
CT_AMEX(3), 
CT_DISCOVER(4), 
CT_DINERS(5), 
CT_JCB(6), 
CT_VISA_ELECTRON(7), 
CT_MAESTRO(8), 
CT_LASER(10)

int dpaymentssdk_globalbenefit_getcardtype(void* lpObj);
int dpaymentssdk_globalbenefit_setcardtype(void* lpObj, int iCardType);

int GetCardType();
int SetCardType(int iCardType);

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 CardNumber is set, but it can also be changed manually. A list of valid card types is included below.

This property is not available at design time.

Data Type

Integer

CardCVVData Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardCVVData();
int SetCardCVVData(const char* lpszCardCVVData);

Unicode (Windows)
LPWSTR GetCardCVVData();
INT SetCardCVVData(LPCWSTR lpszCardCVVData);

char* dpaymentssdk_globalbenefit_getcardcvvdata(void* lpObj);
int dpaymentssdk_globalbenefit_setcardcvvdata(void* lpObj, const char* lpszCardCVVData);

QString GetCardCVVData();
int SetCardCVVData(QString qsCardCVVData);

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 CardCVVData 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, CardCVVPresence will be automatically set to cvpProvided. If set to empty string (""), CardCVVPresence will be automatically set to cvpNotProvided.

This property is not available at design time.

Data Type

String

CardCVVPresence Property (GlobalBenefit Class)

Indicates the presence of the card verification value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

Unicode (Windows)
INT GetCardCVVPresence();
INT SetCardCVVPresence(INT iCardCVVPresence);

CVP_NOT_PROVIDED(0), 
CVP_PROVIDED(1), 
CVP_ILLEGIBLE(2), 
CVP_NOT_ON_CARD(3)

int dpaymentssdk_globalbenefit_getcardcvvpresence(void* lpObj);
int dpaymentssdk_globalbenefit_setcardcvvpresence(void* lpObj, int iCardCVVPresence);

int GetCardCVVPresence();
int SetCardCVVPresence(int iCardCVVPresence);

Default Value

0

Remarks

Indicates the presence of the card verification value.

This property is used to indicate the presence of CardCVVData.

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

Available values are:

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

This property is not available at design time.

Data Type

Integer

CardEntryDataSource Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

Unicode (Windows)
INT GetCardEntryDataSource();
INT SetCardEntryDataSource(INT iCardEntryDataSource);

EDS_TRACK_1(0), 
EDS_TRACK_2(1), 
EDS_MANUAL_ENTRY_TRACK_1CAPABLE(2), 
EDS_MANUAL_ENTRY_TRACK_2CAPABLE(3), 
EDS_MANUAL_ENTRY_NO_CARD_READER(4), 
EDS_TRACK_1CONTACTLESS(5), 
EDS_TRACK_2CONTACTLESS(6), 
EDS_MANUAL_ENTRY_CONTACTLESS_CAPABLE(7), 
EDS_IVR(8), 
EDS_KIOSK(9)

int dpaymentssdk_globalbenefit_getcardentrydatasource(void* lpObj);
int dpaymentssdk_globalbenefit_setcardentrydatasource(void* lpObj, int iCardEntryDataSource);

int GetCardEntryDataSource();
int SetCardEntryDataSource(int iCardEntryDataSource);

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.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (GlobalBenefit Class)

Expiration month of the credit card specified in Number .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

Unicode (Windows)
INT GetCardExpMonth();
INT SetCardExpMonth(INT iCardExpMonth);

int dpaymentssdk_globalbenefit_getcardexpmonth(void* lpObj);
int dpaymentssdk_globalbenefit_setcardexpmonth(void* lpObj, int iCardExpMonth);

int GetCardExpMonth();
int SetCardExpMonth(int iCardExpMonth);

Default Value

1

Remarks

Expiration month of the credit card specified in CardNumber.

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

This property is not available at design time.

Data Type

Integer

CardExpYear Property (GlobalBenefit Class)

Expiration year of the credit card specified in Number .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

Unicode (Windows)
INT GetCardExpYear();
INT SetCardExpYear(INT iCardExpYear);

int dpaymentssdk_globalbenefit_getcardexpyear(void* lpObj);
int dpaymentssdk_globalbenefit_setcardexpyear(void* lpObj, int iCardExpYear);

int GetCardExpYear();
int SetCardExpYear(int iCardExpYear);

Default Value

2000

Remarks

Expiration year of the credit card specified in CardNumber.

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.

This property is not available at design time.

Data Type

Integer

CardIsEncrypted Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCardIsEncrypted();
int SetCardIsEncrypted(int bCardIsEncrypted);

Unicode (Windows)
BOOL GetCardIsEncrypted();
INT SetCardIsEncrypted(BOOL bCardIsEncrypted);

int dpaymentssdk_globalbenefit_getcardisencrypted(void* lpObj);
int dpaymentssdk_globalbenefit_setcardisencrypted(void* lpObj, int bCardIsEncrypted);

bool GetCardIsEncrypted();
int SetCardIsEncrypted(bool bCardIsEncrypted);

Default Value

FALSE

Remarks

Determines whether data set to the CardNumber or CardMagneticStripe fields is validated.

By default, when the CardNumber or CardMagneticStripe fields are set, the value will be validated and normalized. For instance, "4444-33332222 1111" will be normalized as "4444333322221111" and CardMagneticStripe data will be parsed for the track specified by CardEntryDataSource. 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 CardNumber or CardMagneticStripe fields, and this can be accomplished by setting IsEncrypted to true. However, please note that in doing so automatic calculation of the CardType may be affected, and the card number will not be verified.

This property is not available at design time.

Data Type

Boolean

CardMagneticStripe Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardMagneticStripe();
int SetCardMagneticStripe(const char* lpszCardMagneticStripe);

Unicode (Windows)
LPWSTR GetCardMagneticStripe();
INT SetCardMagneticStripe(LPCWSTR lpszCardMagneticStripe);

char* dpaymentssdk_globalbenefit_getcardmagneticstripe(void* lpObj);
int dpaymentssdk_globalbenefit_setcardmagneticstripe(void* lpObj, const char* lpszCardMagneticStripe);

QString GetCardMagneticStripe();
int SetCardMagneticStripe(QString qsCardMagneticStripe);

Default Value

""

Remarks

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

If CardEntryDataSource 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 CardEntryDataSource property to indicate which track you are sending.

The following example shows how to set the CardMagneticStripe and CardEntryDataSource 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.

This property is not available at design time.

Data Type

String

CardNumber Property (GlobalBenefit Class)

Customer's credit card number for the transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCardNumber();
int SetCardNumber(const char* lpszCardNumber);

Unicode (Windows)
LPWSTR GetCardNumber();
INT SetCardNumber(LPCWSTR lpszCardNumber);

char* dpaymentssdk_globalbenefit_getcardnumber(void* lpObj);
int dpaymentssdk_globalbenefit_setcardnumber(void* lpObj, const char* lpszCardNumber);

QString GetCardNumber();
int SetCardNumber(QString qsCardNumber);

Default Value

""

Remarks

Customer's credit card number for the transaction.

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

This property is not available at design time.

Data Type

String

CashBack Property (GlobalBenefit Class)

Optional cash back amount to return to the customer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCashBack();
int SetCashBack(const char* lpszCashBack);

Unicode (Windows)
LPWSTR GetCashBack();
INT SetCashBack(LPCWSTR lpszCashBack);

char* dpaymentssdk_globalbenefit_getcashback(void* lpObj);
int dpaymentssdk_globalbenefit_setcashback(void* lpObj, const char* lpszCashBack);

QString GetCashBack();
int SetCashBack(QString qsCashBack);

Default Value

""

Remarks

For cash back transactions, the TransactionAmount must contain the sum total of the purchase amount PLUS the CashBack amount. If the purchase is for $10 and the customer requests $20 cash back, CashBack should be set to "20.00" and TransactionAmount 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.

Data Type

String

CustomerName Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerName();
int SetCustomerName(const char* lpszCustomerName);

Unicode (Windows)
LPWSTR GetCustomerName();
INT SetCustomerName(LPCWSTR lpszCustomerName);

char* dpaymentssdk_globalbenefit_getcustomername(void* lpObj);
int dpaymentssdk_globalbenefit_setcustomername(void* lpObj, const char* lpszCustomerName);

QString GetCustomerName();
int SetCustomerName(QString qsCustomerName);

Default Value

""

Remarks

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

Data Type

String

EncryptedPIN Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptedPIN();
int SetEncryptedPIN(const char* lpszEncryptedPIN);

Unicode (Windows)
LPWSTR GetEncryptedPIN();
INT SetEncryptedPIN(LPCWSTR lpszEncryptedPIN);

char* dpaymentssdk_globalbenefit_getencryptedpin(void* lpObj);
int dpaymentssdk_globalbenefit_setencryptedpin(void* lpObj, const char* lpszEncryptedPIN);

QString GetEncryptedPIN();
int SetEncryptedPIN(QString qsEncryptedPIN);

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

Data Type

String

InvoiceNumber Property (GlobalBenefit Class)

Optional invoice tracking number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInvoiceNumber();
int SetInvoiceNumber(const char* lpszInvoiceNumber);

Unicode (Windows)
LPWSTR GetInvoiceNumber();
INT SetInvoiceNumber(LPCWSTR lpszInvoiceNumber);

char* dpaymentssdk_globalbenefit_getinvoicenumber(void* lpObj);
int dpaymentssdk_globalbenefit_setinvoicenumber(void* lpObj, const char* lpszInvoiceNumber);

QString GetInvoiceNumber();
int SetInvoiceNumber(QString qsInvoiceNumber);

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.

Data Type

String

KSN Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKSN();
int SetKSN(const char* lpszKSN);

Unicode (Windows)
LPWSTR GetKSN();
INT SetKSN(LPCWSTR lpszKSN);

char* dpaymentssdk_globalbenefit_getksn(void* lpObj);
int dpaymentssdk_globalbenefit_setksn(void* lpObj, const char* lpszKSN);

QString GetKSN();
int SetKSN(QString qsKSN);

Default Value

""

Remarks

A 16-byte Key Serial/Sequence Number (KSN) and associated EncryptedPIN 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 UserId 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()

Data Type

String

Password Property (GlobalBenefit Class)

Password for authentication with the Global Payments Server .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* dpaymentssdk_globalbenefit_getpassword(void* lpObj);
int dpaymentssdk_globalbenefit_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

The Password will be supplied to you by Global Payments.

Data Type

String

ProxyAuthScheme Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int dpaymentssdk_globalbenefit_getproxyauthscheme(void* lpObj);
int dpaymentssdk_globalbenefit_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

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 ProxyUser and ProxyPassword properties are set.

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

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

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int dpaymentssdk_globalbenefit_getproxyautodetect(void* lpObj);
int dpaymentssdk_globalbenefit_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

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.

Data Type

Boolean

ProxyPassword Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* dpaymentssdk_globalbenefit_getproxypassword(void* lpObj);
int dpaymentssdk_globalbenefit_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int dpaymentssdk_globalbenefit_getproxyport(void* lpObj);
int dpaymentssdk_globalbenefit_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* dpaymentssdk_globalbenefit_getproxyserver(void* lpObj);
int dpaymentssdk_globalbenefit_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int dpaymentssdk_globalbenefit_getproxyssl(void* lpObj);
int dpaymentssdk_globalbenefit_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

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:

Data Type

Integer

ProxyUser Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* dpaymentssdk_globalbenefit_getproxyuser(void* lpObj);
int dpaymentssdk_globalbenefit_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Default Value

""

Remarks

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

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RegisterNumber Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRegisterNumber();
int SetRegisterNumber(const char* lpszRegisterNumber);

Unicode (Windows)
LPWSTR GetRegisterNumber();
INT SetRegisterNumber(LPCWSTR lpszRegisterNumber);

char* dpaymentssdk_globalbenefit_getregisternumber(void* lpObj);
int dpaymentssdk_globalbenefit_setregisternumber(void* lpObj, const char* lpszRegisterNumber);

QString GetRegisterNumber();
int SetRegisterNumber(QString qsRegisterNumber);

Default Value

""

Remarks

This may be up to 10 alphanumeric characters in length.

Data Type

String

ResponseApprovalCode Property (GlobalBenefit Class)

Contains the transaction authorization code from the card issuer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovalCode();

Unicode (Windows)
LPWSTR GetResponseApprovalCode();

char* dpaymentssdk_globalbenefit_getresponseapprovalcode(void* lpObj);

QString GetResponseApprovalCode();

Default Value

""

Remarks

Contains the transaction authorization code from the card issuer.

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

This property is read-only.

Data Type

String

ResponseBatchNumber Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseBatchNumber();

Unicode (Windows)
LPWSTR GetResponseBatchNumber();

char* dpaymentssdk_globalbenefit_getresponsebatchnumber(void* lpObj);

QString GetResponseBatchNumber();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

ResponseCardType Property (GlobalBenefit Class)

Indicates the card type or payment method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCardType();

Unicode (Windows)
LPWSTR GetResponseCardType();

char* dpaymentssdk_globalbenefit_getresponsecardtype(void* lpObj);

QString GetResponseCardType();

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.

Data Type

String

ResponseCashBenefitsBalance Property (GlobalBenefit Class)

Balance of cash benefit funds available on the EBT card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCashBenefitsBalance();

Unicode (Windows)
LPWSTR GetResponseCashBenefitsBalance();

char* dpaymentssdk_globalbenefit_getresponsecashbenefitsbalance(void* lpObj);

QString GetResponseCashBenefitsBalance();

Default Value

""

Remarks

Balance of cash benefit funds available on the EBT card. This is the current available balance, less any holds due to pending authorizations or withdrawals, plus any credits or deposits, which are part of the day's activity. If present, this value must be printed on the customer's receipt.

Note that EBT cards may be linked to both a Food Stamp account and a Cash Benefit account, and the balance results for these are returned in the corresponding ResponseFoodStampBalance and ResponseCashBenefitsBalance properties.

This property is read-only.

Data Type

String

ResponseCode Property (GlobalBenefit Class)

Contains the transaction result code from the Global Transport Gateway.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCode();

Unicode (Windows)
LPWSTR GetResponseCode();

char* dpaymentssdk_globalbenefit_getresponsecode(void* lpObj);

QString GetResponseCode();

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 ResponseCode will contain "200", the ResponseMessage will contain "Partial Approval", and the ResponseMessageDetail will contain "PARTIAL AP", "PARTIALLY APPROVED", or "PARTIALLY APPROVED AUTHONLY" (for auth-only transactions). the ResponseAuthorizedAmount will contain the amount of the transaction that was authorized, and the ResponseBalanceDue property will indicate the amount still owed by the customer.

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

This property is read-only.

Data Type

String

ResponseData Property (GlobalBenefit Class)

Contains the raw response data from the Global Payments host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseData();

Unicode (Windows)
LPWSTR GetResponseData();

char* dpaymentssdk_globalbenefit_getresponsedata(void* lpObj);

QString GetResponseData();

Default Value

""

Remarks

Contains the raw response data from the Global Payments host.

This property is read-only.

Data Type

String

ResponseFoodStampBalance Property (GlobalBenefit Class)

Balance of food stamp funds available on the EBT card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseFoodStampBalance();

Unicode (Windows)
LPWSTR GetResponseFoodStampBalance();

char* dpaymentssdk_globalbenefit_getresponsefoodstampbalance(void* lpObj);

QString GetResponseFoodStampBalance();

Default Value

""

Remarks

Balance of food stamp funds available on the EBT card. This is the current available balance, less any holds due to pending authorizations or withdrawals, plus any credits or deposits, which are part of the day's activity. If present, this value must be printed on the customer's receipt.

Note that EBT cards may be linked to both a Food Stamp account and a Cash Benefit account, and the balance results for these are returned in the corresponding ResponseFoodStampBalance and ResponseCashBenefitsBalance properties.

This property is read-only.

Data Type

String

ResponseHostCode Property (GlobalBenefit Class)

Action code returned by Global Payments.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseHostCode();

Unicode (Windows)
LPWSTR GetResponseHostCode();

char* dpaymentssdk_globalbenefit_getresponsehostcode(void* lpObj);

QString GetResponseHostCode();

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

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

This property is read-only.

Data Type

String

ResponseInvoiceNumber Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseInvoiceNumber();

Unicode (Windows)
LPWSTR GetResponseInvoiceNumber();

char* dpaymentssdk_globalbenefit_getresponseinvoicenumber(void* lpObj);

QString GetResponseInvoiceNumber();

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.

Data Type

String

ResponseMerchantCode Property (GlobalBenefit Class)

Merchant Id code which must be printed on all receipts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseMerchantCode();

Unicode (Windows)
LPWSTR GetResponseMerchantCode();

char* dpaymentssdk_globalbenefit_getresponsemerchantcode(void* lpObj);

QString GetResponseMerchantCode();

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.

Data Type

String

ResponseMessage Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseMessage();

Unicode (Windows)
LPWSTR GetResponseMessage();

char* dpaymentssdk_globalbenefit_getresponsemessage(void* lpObj);

QString GetResponseMessage();

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

This property is read-only.

Data Type

String

ResponseMessageDetail Property (GlobalBenefit Class)

Contains a formatted response message concerning the processed transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseMessageDetail();

Unicode (Windows)
LPWSTR GetResponseMessageDetail();

char* dpaymentssdk_globalbenefit_getresponsemessagedetail(void* lpObj);

QString GetResponseMessageDetail();

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 ResponseMessage 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 ResponseCode property instead.

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

This property is read-only.

Data Type

String

ResponsePNRef Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponsePNRef();

Unicode (Windows)
LPWSTR GetResponsePNRef();

char* dpaymentssdk_globalbenefit_getresponsepnref(void* lpObj);

QString GetResponsePNRef();

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.

Data Type

String

Server Property (GlobalBenefit Class)

Global Payments transaction server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServer();
int SetServer(const char* lpszServer);

Unicode (Windows)
LPWSTR GetServer();
INT SetServer(LPCWSTR lpszServer);

char* dpaymentssdk_globalbenefit_getserver(void* lpObj);
int dpaymentssdk_globalbenefit_setserver(void* lpObj, const char* lpszServer);

QString GetServer();
int SetServer(QString qsServer);

Default Value

"https://api.globalpay.com"

Remarks

This is the server to which all transactions are sent. The live URL for Global Payments is "https://api.globalpay.com". For testing and certification purposes you may set this to the test server located at "https://certapia.globalpay.com" instead.

Data Type

String

SSLAcceptServerCertEncoded Property (GlobalBenefit Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int dpaymentssdk_globalbenefit_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dpaymentssdk_globalbenefit_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (GlobalBenefit Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int dpaymentssdk_globalbenefit_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dpaymentssdk_globalbenefit_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int dpaymentssdk_globalbenefit_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dpaymentssdk_globalbenefit_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

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

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is 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).

Data Type

Binary String

SSLCertStorePassword Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* dpaymentssdk_globalbenefit_getsslcertstorepassword(void* lpObj);
int dpaymentssdk_globalbenefit_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (GlobalBenefit Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int dpaymentssdk_globalbenefit_getsslcertstoretype(void* lpObj);
int dpaymentssdk_globalbenefit_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

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:

Data Type

Integer

SSLCertSubject Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* dpaymentssdk_globalbenefit_getsslcertsubject(void* lpObj);
int dpaymentssdk_globalbenefit_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

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.

Data Type

String

SSLProvider Property (GlobalBenefit Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dpaymentssdk_globalbenefit_getsslprovider(void* lpObj);
int dpaymentssdk_globalbenefit_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

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.

Data Type

Integer

SSLServerCertEncoded Property (GlobalBenefit Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int dpaymentssdk_globalbenefit_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (GlobalBenefit Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dpaymentssdk_globalbenefit_gettimeout(void* lpObj);
int dpaymentssdk_globalbenefit_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

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

Data Type

Integer

TransactionAmount Property (GlobalBenefit Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionAmount();
int SetTransactionAmount(const char* lpszTransactionAmount);

Unicode (Windows)
LPWSTR GetTransactionAmount();
INT SetTransactionAmount(LPCWSTR lpszTransactionAmount);

char* dpaymentssdk_globalbenefit_gettransactionamount(void* lpObj);
int dpaymentssdk_globalbenefit_settransactionamount(void* lpObj, const char* lpszTransactionAmount);

QString GetTransactionAmount();
int SetTransactionAmount(QString qsTransactionAmount);

Default Value

""

Remarks

This is required for Sale, AuthOnly, Refund, and Force transactions. It is optional or ignored for all others. 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.

Note that the TransactionAmount should include any GratuityAmount and/or TaxAmount. For example, if the sale price of the transaction is $10.00, and the tip on the transaction is $3.00 (for a grand total of $13.00), the TransactionAmount property should contain "13.00" and the GratuityAmount property should contain "3.00".

Data Type

String

UserId Property (GlobalBenefit Class)

UserId for authentication with the Global Payments Server .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUserId();
int SetUserId(const char* lpszUserId);

Unicode (Windows)
LPWSTR GetUserId();
INT SetUserId(LPCWSTR lpszUserId);

char* dpaymentssdk_globalbenefit_getuserid(void* lpObj);
int dpaymentssdk_globalbenefit_setuserid(void* lpObj, const char* lpszUserId);

QString GetUserId();
int SetUserId(QString qsUserId);

Default Value

""

Remarks

The UserId will be supplied to you by Global Payments.

Data Type

String

BalanceInquiry Method (GlobalBenefit Class)

Retrieves the current balances of Food Stamp and Cash Benefit accounts on an EBT card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BalanceInquiry();

Unicode (Windows)
INT BalanceInquiry();

int dpaymentssdk_globalbenefit_balanceinquiry(void* lpObj);

int BalanceInquiry();

Remarks

A BalanceInquiry transaction requests that Global Payments return the amount of funds remaining on the customer's EBT Card. No charge is made to the customer's card. The balance results from a balance inquiry on a Food Stamps card will be returned in ResponseFoodStampBalance, and the balance results from an inquiry on a Cash Benefits card will be returned in ResponseCashBenefitsBalance. For a card that accesses both Food Stamp and Cash Benefit accounts, both balances may be returned.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (GlobalBenefit Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dpaymentssdk_globalbenefit_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Interrupt Method (GlobalBenefit Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int dpaymentssdk_globalbenefit_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Refund Method (GlobalBenefit Class)

Submits a food stamp credit transaction, returning funds to an EBT card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Refund(const char* lpszPNRef);

Unicode (Windows)
INT Refund(LPCWSTR lpszPNRef);

int dpaymentssdk_globalbenefit_refund(void* lpObj, const char* lpszPNRef);

int Refund(const QString& qsPNRef);

Remarks

EBT credit (return) transactions are similar to debit credits in that they are real-time -- Funds are immediately added back to the customer's food stamp account, instead of the funds transfer taking place several days after settlement. EBT credits may use track2 data read from the card's magnetic stripe, or be manually keyed. Track1 data is not acceptable. The customer is required to enter enter their PIN into a certified PIN Pad device, and both an EncryptedPIN and KSN are returned from the pad to the merchant, and must be submitted in the Credit/Refund transaction.

Note that credits are only supported for the food stamp BenefitType. Attempting to send a Refund when the BenefitType is set to Cash Benefits will result in an error.

This transaction is automatically added to the current open batch, and will be settled after the current batch is released with the GlobalBatchMgr class.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (GlobalBenefit Class)

Clears all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dpaymentssdk_globalbenefit_reset(void* lpObj);

int Reset();

Remarks

This method clears all properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Sale Method (GlobalBenefit Class)

Submits a sale transaction for an Electronic Benefits (EBT) card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Sale();

Unicode (Windows)
INT Sale();

int dpaymentssdk_globalbenefit_sale(void* lpObj);

int Sale();

Remarks

EBT sale transactions are similar to Debit card transactions in that they are real-time and require an EncryptedPIN and KSN. EBT cards are connected to either a Food Stamp account or a Cash Benefit account, or both. Like debit transactions, EBT transactions also must use track2 data read from the card's magnetic stripe - track1 data is not acceptable. Food stamp transactions MAY be manually keyed, but cash benefit transactions may NOT be manually keyed. The BenefitType property indicates whether the sale acts on a Food Stamp or Cash Benefit account.

This transaction is automatically added to the current open batch, and will be settled after the current batch is released with the GlobalBatchMgr class.

The EBT card may be specified by either a CardMagneticStripe returned by a card reader, (Track2 only), or manually entered through the CardNumber. CardExpMonth, and CardExpYear.

The ResponseCode and ResponseText properties indicate whether this transaction was successful. For example:

Swiped Cash Benefits transaction with cash back: class.CardEntryDataSource = edsMagneticStripe class.CardMagneticStripe = "9999999800002773=09121015432112345678" class.EncryptedPIN = "623F36B53CC18393" class.KSN = "000000008F000021" class.BenefitType = btCashBenefits class.TransactionAmount = "25.00" '$20 purchase with $5 cash back class.CashBack = "5.00" class.Sale

Manually-keyed Food Stamp transaction: class.CardEntryDataSource = edsManuallyEntered class.CardNumber = "9999999800002773" class.CardExpYear = 12 class.CardExpMonth = 2015 class.EncryptedPIN = "623F36B53CC18393" class.KSN = "000000008F000021" class.BenefitType = btFoodStamps class.TransactionAmount = "25.00" 'Cash back not supported for food stamps! class.Sale

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VoucherSale Method (GlobalBenefit Class)

Used to clear (force) a food stamp voucher that was previously voice-authorized.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int VoucherSale(const char* lpszAuthCode, const char* lpszVoucherNumber);

Unicode (Windows)
INT VoucherSale(LPCWSTR lpszAuthCode, LPCWSTR lpszVoucherNumber);

int dpaymentssdk_globalbenefit_vouchersale(void* lpObj, const char* lpszAuthCode, const char* lpszVoucherNumber);

int VoucherSale(const QString& qsAuthCode, const QString& qsVoucherNumber);

Remarks

If any aspect of the EBT system is down, the merchant may call the issuing state's processor for a voice authorization for Food Stamp transactions only. The merchant must complete a Manual Voucher form (provided by Global Payments or state EBT contractor) to obtain the authorization number, the voucher number and the client's signature. This puts a hold on the funds in the client's account for the amount of the voice authorization. To receive payment for the transaction, the merchant must process a Voucher Clear transaction within ten days of the voice authorization. To send a voucher clear/voucher sale, just call this method with the AuthCode and VoucherNumber parameters set.

Note that only food stamp transactions may be voice-authorized, attempting to call this method when the BenefitType is set to Cash Benefits will result in an error.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (GlobalBenefit Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(GlobalBenefitErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} GlobalBenefitErrorEventParams;


Unicode (Windows)
virtual INT FireError(GlobalBenefitErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} GlobalBenefitErrorEventParams;

#define EID_GLOBALBENEFIT_ERROR 1

virtual INT DPAYMENTSSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class GlobalBenefitErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(GlobalBenefitErrorEventParams *e);

// Or, subclass GlobalBenefit and override this emitter function.
virtual int FireError(GlobalBenefitErrorEventParams *e) {...}

Remarks

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

SSLServerAuthentication Event (GlobalBenefit Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(GlobalBenefitSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} GlobalBenefitSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(GlobalBenefitSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} GlobalBenefitSSLServerAuthenticationEventParams;

#define EID_GLOBALBENEFIT_SSLSERVERAUTHENTICATION 2

virtual INT DPAYMENTSSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class GlobalBenefitSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(GlobalBenefitSSLServerAuthenticationEventParams *e);

// Or, subclass GlobalBenefit and override this emitter function.
virtual int FireSSLServerAuthentication(GlobalBenefitSSLServerAuthenticationEventParams *e) {...}

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.

SSLStatus Event (GlobalBenefit Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(GlobalBenefitSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} GlobalBenefitSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(GlobalBenefitSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} GlobalBenefitSSLStatusEventParams;

#define EID_GLOBALBENEFIT_SSLSTATUS 3

virtual INT DPAYMENTSSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class GlobalBenefitSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(GlobalBenefitSSLStatusEventParams *e);

// Or, subclass GlobalBenefit and override this emitter function.
virtual int FireSSLStatus(GlobalBenefitSSLStatusEventParams *e) {...}

Remarks

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

Status Event (GlobalBenefit Class)

Shows the progress of the Global Payments connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStatus(GlobalBenefitStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} GlobalBenefitStatusEventParams;


Unicode (Windows)
virtual INT FireStatus(GlobalBenefitStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} GlobalBenefitStatusEventParams;

#define EID_GLOBALBENEFIT_STATUS 4

virtual INT DPAYMENTSSDK_CALL FireStatus(LPSTR &lpszMessage);

class GlobalBenefitStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Status(GlobalBenefitStatusEventParams *e);

// Or, subclass GlobalBenefit and override this emitter function.
virtual int FireStatus(GlobalBenefitStatusEventParams *e) {...}

Remarks

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

Config Settings (GlobalBenefit Class)

GlobalBenefit 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

Trappable Errors (GlobalBenefit Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GlobalBenefit 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