Retail Class

Properties   Methods   Events   Config Settings   Errors  

The Retail class is used to authorize credit card transactions with any of the supported Internet Payment Gateways.

Syntax

Retail

Remarks

The Retail class allows you to use multiple Internet Payment Gateways through one interface and one class. This allows for easy migration from one gateway to another, as well as quick integration into applications or web services.

The Retail class allows your website to securely perform credit card transactions without the need to redirect to a third-party site. All transactions are accomplished through a secure HTTPS Post to any supported gateway. The secure response is received and then stored in the class's response properties. Any web site on a standard HTTP server or any stand-alone application can process transactions without the need for a secure server or third-party intervention.

The first thing you must do is select one of the many gateways supported by the Retail class, and set up an account with that gateway vendor. Once you have an account set up with a valid (or test) login Id and password, you can use the Retail class.

To begin, set the Gateway property to the gateway you wish to use. If this gateway supports an alternate URL to send test transactions to, set the GatewayURL at this time.

Next, set the MerchantLogin (and for some gateways the MerchantPassword). These are supplied by your gateway vendor when you set up an account.

Now you are ready to process transactions. For each transaction, you can set the Card and TransactionAmount properties. For swiped card transactions you can set CardMagneticStripe or for manually entered transactions you can set CardNumber, CardExpMonth, CardExpYear. Most gateways will also require additional properties, such as CustomerAddress, CustomerFirstName, CustomerLastName, InvoiceNumber, etc. Any additional required properties are listed in the Gateway property description.

Once these properties are set, you may run validity checks on the card data with the AVSOnly method, or simply authorize the transaction with the Sale method. If your Gateway supports them, you may also perform a wide variety of transaction types such as VoidTransaction, Refund, Credit, or Force. Please review the method pages for further details about these methods and their designed functionality.

The following gateways are supported by the Retail class:

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.

AuthCode Property (Retail Class)

Authorization code from a previous transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthCode();
int SetAuthCode(const char* lpszAuthCode);

Unicode (Windows)
LPWSTR GetAuthCode();
INT SetAuthCode(LPCWSTR lpszAuthCode);

char* inpay_retail_getauthcode(void* lpObj);
int inpay_retail_setauthcode(void* lpObj, const char* lpszAuthCode);

QString GetAuthCode();
int SetAuthCode(QString qsAuthCode);

Default Value

""

Remarks

Some gateways require the merchant to include the ResponseApprovalCode from the original transaction in Credit, VoidTransaction, and Capture transactions. You may send the original approval code in this AuthCode property. The gateways which require this are listed below:

• gwIntellipay (3)
• gwBankOfAmerica (13)
• gwInnovative (14)
• gwACHPAyments (35)
• gwForte (36)
• gwSagePay (50)
• gwDataCash (77)
• gwFirstDataE4 (80)

Data Type

String

CardType Property (Retail 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 inpay_retail_getcardtype(void* lpObj);
int inpay_retail_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 (Retail 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* inpay_retail_getcardcvvdata(void* lpObj);
int inpay_retail_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 (Retail 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 inpay_retail_getcardcvvpresence(void* lpObj);
int inpay_retail_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 (Retail 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 inpay_retail_getcardentrydatasource(void* lpObj);
int inpay_retail_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.

This property is not available at design time.

Data Type

Integer

CardExpMonth Property (Retail 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 inpay_retail_getcardexpmonth(void* lpObj);
int inpay_retail_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 (Retail 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 inpay_retail_getcardexpyear(void* lpObj);
int inpay_retail_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 (Retail 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 inpay_retail_getcardisencrypted(void* lpObj);
int inpay_retail_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 (Retail 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* inpay_retail_getcardmagneticstripe(void* lpObj);
int inpay_retail_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 (Retail 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* inpay_retail_getcardnumber(void* lpObj);
int inpay_retail_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

CustomerAddress Property (Retail Class)

Customer's street address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerAddress();
int SetCustomerAddress(const char* lpszCustomerAddress);

Unicode (Windows)
LPWSTR GetCustomerAddress();
INT SetCustomerAddress(LPCWSTR lpszCustomerAddress);

char* inpay_retail_getcustomeraddress(void* lpObj);
int inpay_retail_setcustomeraddress(void* lpObj, const char* lpszCustomerAddress);

QString GetCustomerAddress();
int SetCustomerAddress(QString qsCustomerAddress);

Default Value

""

Remarks

Customer's street address. This property is used as part of the Address Verification Service (AVS) and contains the customer's street address as it appears on their monthly statement. Only the street number, street name, and apartment number are required in This property. City, state, and zip code are set in the CustomerCity, CustomerState, and CustomerZip properties.

The length of this property varies by gateway. If the customer's address is very long, it is admissible to include only the street number in This property.

NOTE: For the Moneris gateway, this property should contain only the customer's street number. The street name should be added via the AddSpecialField method. For example:

class.CustomerAddress = "123" class.AddSpecialField("avs_street_name", "Nowhere Ln")

This property is not available at design time.

Data Type

String

CustomerAddress2 Property (Retail Class)

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerAddress2();
int SetCustomerAddress2(const char* lpszCustomerAddress2);

Unicode (Windows)
LPWSTR GetCustomerAddress2();
INT SetCustomerAddress2(LPCWSTR lpszCustomerAddress2);

char* inpay_retail_getcustomeraddress2(void* lpObj);
int inpay_retail_setcustomeraddress2(void* lpObj, const char* lpszCustomerAddress2);

QString GetCustomerAddress2();
int SetCustomerAddress2(QString qsCustomerAddress2);

Default Value

""

Remarks

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).

This property is not available at design time.

Data Type

String

CustomerAggregate Property (Retail Class)

This property allows you to get or set an XML aggregate built from all of the Customer properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerAggregate();
int SetCustomerAggregate(const char* lpszCustomerAggregate);

Unicode (Windows)
LPWSTR GetCustomerAggregate();
INT SetCustomerAggregate(LPCWSTR lpszCustomerAggregate);

char* inpay_retail_getcustomeraggregate(void* lpObj);
int inpay_retail_setcustomeraggregate(void* lpObj, const char* lpszCustomerAggregate);

QString GetCustomerAggregate();
int SetCustomerAggregate(QString qsCustomerAggregate);

Default Value

""

Remarks

This property allows you to get or set an XML aggregate built from all of the Customer properties. "EPCustomer" is the root element. The Customer properties make up the tags under the root, but without the beginning "Customer". For instance: <EPCustomer> <Address>123 Nowhere Ln.</Address> <Address2>Apt 3B.</Address2> <City>Beverly Hills</City> ... </EPCustomer>

This property is not available at design time.

Data Type

String

CustomerCity Property (Retail Class)

Customer's city.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerCity();
int SetCustomerCity(const char* lpszCustomerCity);

Unicode (Windows)
LPWSTR GetCustomerCity();
INT SetCustomerCity(LPCWSTR lpszCustomerCity);

char* inpay_retail_getcustomercity(void* lpObj);
int inpay_retail_setcustomercity(void* lpObj, const char* lpszCustomerCity);

QString GetCustomerCity();
int SetCustomerCity(QString qsCustomerCity);

Default Value

""

Remarks

Customer's city. This property is used as part of the Address Verification Service (AVS) and contains the customer's city as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerState, and CustomerZip.

This property is not available at design time.

Data Type

String

CustomerCountry Property (Retail Class)

Customer's country.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerCountry();
int SetCustomerCountry(const char* lpszCustomerCountry);

Unicode (Windows)
LPWSTR GetCustomerCountry();
INT SetCustomerCountry(LPCWSTR lpszCustomerCountry);

char* inpay_retail_getcustomercountry(void* lpObj);
int inpay_retail_setcustomercountry(void* lpObj, const char* lpszCustomerCountry);

QString GetCustomerCountry();
int SetCustomerCountry(QString qsCustomerCountry);

Default Value

""

Remarks

Customer's country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.

Note: If using this property with the PayFuse gateway, this property should contain the ISO-3166 numeric code instead of the standard two-letter code. For example, the ISO code for the US is "840".

This property is not available at design time.

Data Type

String

CustomerEmail Property (Retail Class)

Customer's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerEmail();
int SetCustomerEmail(const char* lpszCustomerEmail);

Unicode (Windows)
LPWSTR GetCustomerEmail();
INT SetCustomerEmail(LPCWSTR lpszCustomerEmail);

char* inpay_retail_getcustomeremail(void* lpObj);
int inpay_retail_setcustomeremail(void* lpObj, const char* lpszCustomerEmail);

QString GetCustomerEmail();
int SetCustomerEmail(QString qsCustomerEmail);

Default Value

""

Remarks

Customer's email address. This optional property contains the customer's email address.

This property is not available at design time.

Data Type

String

CustomerFax Property (Retail Class)

Customer's fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerFax();
int SetCustomerFax(const char* lpszCustomerFax);

Unicode (Windows)
LPWSTR GetCustomerFax();
INT SetCustomerFax(LPCWSTR lpszCustomerFax);

char* inpay_retail_getcustomerfax(void* lpObj);
int inpay_retail_setcustomerfax(void* lpObj, const char* lpszCustomerFax);

QString GetCustomerFax();
int SetCustomerFax(QString qsCustomerFax);

Default Value

""

Remarks

Customer's fax number. This optional property contains the customer's fax number.

This property is not available at design time.

Data Type

String

CustomerFirstName Property (Retail Class)

Customer's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerFirstName();
int SetCustomerFirstName(const char* lpszCustomerFirstName);

Unicode (Windows)
LPWSTR GetCustomerFirstName();
INT SetCustomerFirstName(LPCWSTR lpszCustomerFirstName);

char* inpay_retail_getcustomerfirstname(void* lpObj);
int inpay_retail_setcustomerfirstname(void* lpObj, const char* lpszCustomerFirstName);

QString GetCustomerFirstName();
int SetCustomerFirstName(QString qsCustomerFirstName);

Default Value

""

Remarks

Customer's first name. This property contains the customer's first name.

This property is not available at design time.

Data Type

String

CustomerFullName Property (Retail Class)

Customer's full name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerFullName();
int SetCustomerFullName(const char* lpszCustomerFullName);

Unicode (Windows)
LPWSTR GetCustomerFullName();
INT SetCustomerFullName(LPCWSTR lpszCustomerFullName);

char* inpay_retail_getcustomerfullname(void* lpObj);
int inpay_retail_setcustomerfullname(void* lpObj, const char* lpszCustomerFullName);

QString GetCustomerFullName();
int SetCustomerFullName(QString qsCustomerFullName);

Default Value

""

Remarks

Customer's full name. This property contains the customer's full name as it appears on the credit card or bank account. Many gateways use this property in addition to, or instead of, the CustomerFirstName and CustomerLastName properties. If a gateway requires a CustomerFullName and the property is empty, CustomerFullName will be constructed using the contents of CustomerFirstName and CustomerLastName.

This property is not available at design time.

Data Type

String

CustomerId Property (Retail Class)

Merchant-generated customer Id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerId();
int SetCustomerId(const char* lpszCustomerId);

Unicode (Windows)
LPWSTR GetCustomerId();
INT SetCustomerId(LPCWSTR lpszCustomerId);

char* inpay_retail_getcustomerid(void* lpObj);
int inpay_retail_setcustomerid(void* lpObj, const char* lpszCustomerId);

QString GetCustomerId();
int SetCustomerId(QString qsCustomerId);

Default Value

""

Remarks

Merchant-generated customer Id. This property contains a merchant-generated customer identification number. This number should be unique for each different customer that places an order with the merchant.

This property is not available at design time.

Data Type

String

CustomerLastName Property (Retail Class)

Customer's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerLastName();
int SetCustomerLastName(const char* lpszCustomerLastName);

Unicode (Windows)
LPWSTR GetCustomerLastName();
INT SetCustomerLastName(LPCWSTR lpszCustomerLastName);

char* inpay_retail_getcustomerlastname(void* lpObj);
int inpay_retail_setcustomerlastname(void* lpObj, const char* lpszCustomerLastName);

QString GetCustomerLastName();
int SetCustomerLastName(QString qsCustomerLastName);

Default Value

""

Remarks

Customer's last name. This property contains the customer's last name as it appears on their credit card.

This property is not available at design time.

Data Type

String

CustomerPhone Property (Retail Class)

Customer's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerPhone();
int SetCustomerPhone(const char* lpszCustomerPhone);

Unicode (Windows)
LPWSTR GetCustomerPhone();
INT SetCustomerPhone(LPCWSTR lpszCustomerPhone);

char* inpay_retail_getcustomerphone(void* lpObj);
int inpay_retail_setcustomerphone(void* lpObj, const char* lpszCustomerPhone);

QString GetCustomerPhone();
int SetCustomerPhone(QString qsCustomerPhone);

Default Value

""

Remarks

Customer's phone number. This optional property contains the customer's phone number.

This property is not available at design time.

Data Type

String

CustomerState Property (Retail Class)

Customer's state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerState();
int SetCustomerState(const char* lpszCustomerState);

Unicode (Windows)
LPWSTR GetCustomerState();
INT SetCustomerState(LPCWSTR lpszCustomerState);

char* inpay_retail_getcustomerstate(void* lpObj);
int inpay_retail_setcustomerstate(void* lpObj, const char* lpszCustomerState);

QString GetCustomerState();
int SetCustomerState(QString qsCustomerState);

Default Value

""

Remarks

Customer's state. This property is used as part of the Address Verification Service (AVS) and contains the two character postal abbreviation of the customer's state as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerZip.

This property is not available at design time.

Data Type

String

CustomerZip Property (Retail Class)

Customer's zip code (or postal code if outside of the USA).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCustomerZip();
int SetCustomerZip(const char* lpszCustomerZip);

Unicode (Windows)
LPWSTR GetCustomerZip();
INT SetCustomerZip(LPCWSTR lpszCustomerZip);

char* inpay_retail_getcustomerzip(void* lpObj);
int inpay_retail_setcustomerzip(void* lpObj, const char* lpszCustomerZip);

QString GetCustomerZip();
int SetCustomerZip(QString qsCustomerZip);

Default Value

""

Remarks

Customer's zip code (or postal code if outside of the USA). This property is used as part of the Address Verification Service (AVS), and contains the customer's zip code as it appears on their monthly statement. Other AVS properties include CustomerAddress, CustomerCity, and CustomerState.

This property is not available at design time.

Data Type

String

Gateway Property (Retail Class)

Gateway to process transactions with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetGateway();
int SetGateway(int iGateway);

Unicode (Windows)
INT GetGateway();
INT SetGateway(INT iGateway);

RGW_NO_GATEWAY(0), 
RGW_AUTHORIZE_NET(1), 
RGW_EPROCESSING(2), 
RGW_ITRANSACT(4), 
RGW_NET_BILLING(5), 
RGW_PAY_FLOW_PRO(6), 
RGW_USAE_PAY(7), 
RGW_PLUG_NPAY(8), 
RGW_PLANET_PAYMENT(9), 
RGW_MPCS(10), 
RGW_RTWARE(11), 
RGW_ECX(12), 
RGW_BANK_OF_AMERICA(13), 
RGW_MERCHANT_ANYWHERE(15), 
RGW_SKIPJACK(16), 
RGW_TRUST_COMMERCE(19), 
RGW_PAY_FUSE(21), 
RGW_LINK_POINT(24), 
RGW_FAST_TRANSACT(27), 
RGW_NETWORK_MERCHANTS(28), 
RGW_PRIGATE(30), 
RGW_MERCHANT_PARTNERS(31), 
RGW_FIRST_DATA(33), 
RGW_YOUR_PAY(34), 
RGW_ACHPAYMENTS(35), 
RGW_FORTE(36), 
RGW_CYBER_SOURCE(37), 
RGW_GO_EMERCHANT(39), 
RGW_CHASE(41), 
RGW_NEX_COMMERCE(42), 
RGW_TRANSACTION_CENTRAL(44), 
RGW_STERLING(45), 
RGW_PAY_JUNCTION(46), 
RGW_MY_VIRTUAL_MERCHANT(49), 
RGW_VERIFI(54), 
RGW_MERCHANT_ESOLUTIONS(56), 
RGW_PAY_LEAP(57), 
RGW_WORLD_PAY_XML(59), 
RGW_PRO_PAY(60), 
RGW_QBMS(61), 
RGW_HEARTLAND(62), 
RGW_LITLE(63), 
RGW_BRAIN_TREE(64), 
RGW_JET_PAY(65), 
RGW_HSBC(66), 
RGW_BLUE_PAY(67), 
RGW_PAY_TRACE(70), 
RGW_TRANS_NATIONAL_BANKCARD(74), 
RGW_FIRST_DATA_E4(80), 
RGW_BLUEFIN(82), 
RGW_PAYSCAPE(83), 
RGW_PAY_DIRECT(84), 
RGW_WORLD_PAY_LINK(87), 
RGW_PAYMENT_WORK_SUITE(88), 
RGW_FIRST_DATA_PAY_POINT(90), 
RGW_PAYEEZY(94), 
RGW_AUTHORIZE_NET_XML(96), 
RGW_PHOENI_XGATE(97), 
RGW_REPAY(98), 
RGW_BASYS(106), 
RGW_QBPAYMENTS(113), 
RGW_SHIFT_4(114), 
RGW_HEARTLAND_PORTICO(116), 
RGW_PAY_TRACE_JSON(117)

int inpay_retail_getgateway(void* lpObj);
int inpay_retail_setgateway(void* lpObj, int iGateway);

int GetGateway();
int SetGateway(int iGateway);

Default Value

0

Remarks

This property is used to select the gateway with which transactions will be processed. Setting the Gateway property will also fill the GatewayURL, SpecialFieldName, and SpecialFieldValue properties with default data for the selected gateway. The following table shows the currently supported gateways, as well as the corporate home page for each.

Data Type

Integer

GatewayURL Property (Retail Class)

Default URL for a specific Gateway .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetGatewayURL();
int SetGatewayURL(const char* lpszGatewayURL);

Unicode (Windows)
LPWSTR GetGatewayURL();
INT SetGatewayURL(LPCWSTR lpszGatewayURL);

char* inpay_retail_getgatewayurl(void* lpObj);
int inpay_retail_setgatewayurl(void* lpObj, const char* lpszGatewayURL);

QString GetGatewayURL();
int SetGatewayURL(QString qsGatewayURL);

Default Value

""

Remarks

This property is used to change the default URL for a specific Gateway. This is useful for specifying a different URL for testing purposes, or to support additional gateway processors that share a protocol format (such as additional Authorize.net compatible gateways). Please note that the proper "http://" or "https://" formatting must be observed. See "Testing Information" in the Table of Contents for a list of test URLs.

Data Type

String

InvoiceNumber Property (Retail Class)

Merchant-generated invoice number.

Syntax

• C++
• C
• Qt

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

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

char* inpay_retail_getinvoicenumber(void* lpObj);
int inpay_retail_setinvoicenumber(void* lpObj, const char* lpszInvoiceNumber);

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

Default Value

""

Remarks

This field contains a merchant-generated invoice number. This number should be unique for each transaction. This property is optional for most gateways, but it is recommended that the merchant use an invoice number to keep track of transactions. See the Gateway property to determine if this is a required or optional field for the gateway you are using.

Data Type

String

Level2Aggregate Property (Retail Class)

The level 2 aggregate containing the data to be sent in the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel2Aggregate();
int SetLevel2Aggregate(const char* lpszLevel2Aggregate);

Unicode (Windows)
LPWSTR GetLevel2Aggregate();
INT SetLevel2Aggregate(LPCWSTR lpszLevel2Aggregate);

char* inpay_retail_getlevel2aggregate(void* lpObj);
int inpay_retail_setlevel2aggregate(void* lpObj, const char* lpszLevel2Aggregate);

QString GetLevel2Aggregate();
int SetLevel2Aggregate(QString qsLevel2Aggregate);

Default Value

""

Remarks

This property is used to specify the level 2 aggregate obtained from Level2 class. When specified, the class will parse the aggregate and send the specified values within the transaction request to process the transaction as a level 2 transaction.

Data Type

String

Level3Aggregate Property (Retail Class)

The level 3 aggregate containing the data to be sent in the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLevel3Aggregate();
int SetLevel3Aggregate(const char* lpszLevel3Aggregate);

Unicode (Windows)
LPWSTR GetLevel3Aggregate();
INT SetLevel3Aggregate(LPCWSTR lpszLevel3Aggregate);

char* inpay_retail_getlevel3aggregate(void* lpObj);
int inpay_retail_setlevel3aggregate(void* lpObj, const char* lpszLevel3Aggregate);

QString GetLevel3Aggregate();
int SetLevel3Aggregate(QString qsLevel3Aggregate);

Default Value

""

Remarks

This property is used to specify the level 3 aggregate obtained from Level3 class. When specified, the class will parse the aggregate and send the specified values within the transaction request to process the transaction as a level 3 transaction.

Data Type

String

MerchantLogin Property (Retail Class)

Merchant's Gateway login.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantLogin();
int SetMerchantLogin(const char* lpszMerchantLogin);

Unicode (Windows)
LPWSTR GetMerchantLogin();
INT SetMerchantLogin(LPCWSTR lpszMerchantLogin);

char* inpay_retail_getmerchantlogin(void* lpObj);
int inpay_retail_setmerchantlogin(void* lpObj, const char* lpszMerchantLogin);

QString GetMerchantLogin();
int SetMerchantLogin(QString qsMerchantLogin);

Default Value

""

Remarks

This is the login Id supplied by the Gateway you signed up with to process credit card transactions.

Data Type

String

MerchantPassword Property (Retail Class)

Merchant's Gateway password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMerchantPassword();
int SetMerchantPassword(const char* lpszMerchantPassword);

Unicode (Windows)
LPWSTR GetMerchantPassword();
INT SetMerchantPassword(LPCWSTR lpszMerchantPassword);

char* inpay_retail_getmerchantpassword(void* lpObj);
int inpay_retail_setmerchantpassword(void* lpObj, const char* lpszMerchantPassword);

QString GetMerchantPassword();
int SetMerchantPassword(QString qsMerchantPassword);

Default Value

""

Remarks

This is the password supplied by the Gateway you signed up with to process credit card transactions. Some gateways require passwords only for Credit or Void transactions, some require it for all transactions, and some do not require this field at all.

Data Type

String

ProxyAuthScheme Property (Retail 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 inpay_retail_getproxyauthscheme(void* lpObj);
int inpay_retail_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 (Retail 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 inpay_retail_getproxyautodetect(void* lpObj);
int inpay_retail_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 (Retail 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* inpay_retail_getproxypassword(void* lpObj);
int inpay_retail_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 (Retail 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 inpay_retail_getproxyport(void* lpObj);
int inpay_retail_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 (Retail 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* inpay_retail_getproxyserver(void* lpObj);
int inpay_retail_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 (Retail 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 inpay_retail_getproxyssl(void* lpObj);
int inpay_retail_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 (Retail Class)

This property contains a user name, 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* inpay_retail_getproxyuser(void* lpObj);
int inpay_retail_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

Default Value

""

Remarks

This property contains a user name, 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

ResponseApprovalCode Property (Retail Class)

Contains an authorization code when a transaction has been approved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovalCode();

Unicode (Windows)
LPWSTR GetResponseApprovalCode();

char* inpay_retail_getresponseapprovalcode(void* lpObj);

QString GetResponseApprovalCode();

Default Value

""

Remarks

Contains an authorization code when a transaction has been approved. This property contains an authorization code when a transaction has been approved. If the ResponseCode returned indicates that the transaction is not approved, then the contents of this property should be ignored.

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

Data Type

String

ResponseApproved Property (Retail Class)

Indicates the status of the last transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResponseApproved();

Unicode (Windows)
BOOL GetResponseApproved();

int inpay_retail_getresponseapproved(void* lpObj);

bool GetResponseApproved();

Default Value

FALSE

Remarks

Indicates the status of the last transaction. This property will be True if the last transaction was approved. However, you should not rely solely on the value contained in this property. After every transaction, the ResponseCode should be inspected and evaluated according to the specifications of the Gateway in use. A list of response codes for each gateway is listed in the table of contents. However, it is recommended that the developer acquire the current list from the Gateway which is being used.

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

Data Type

Boolean

ResponseApprovedAmount Property (Retail Class)

The amount approved for the transaction, this is the amount actually charged to the credit card.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseApprovedAmount();

Unicode (Windows)
LPWSTR GetResponseApprovedAmount();

char* inpay_retail_getresponseapprovedamount(void* lpObj);

QString GetResponseApprovedAmount();

Default Value

""

Remarks

The amount approved for the transaction, this is the amount actually charged to the credit card.

This property is primarily used when gateways allow partial authorizations and AllowPartialAuths is 'True'. Thus this property is not used by all gateways and should not alone be used to determine if a transaction was successful (such as in the case that this property is not populated).

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

Data Type

String

ResponseAVSResult Property (Retail Class)

Contains the Address Verification System result code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseAVSResult();

Unicode (Windows)
LPWSTR GetResponseAVSResult();

char* inpay_retail_getresponseavsresult(void* lpObj);

QString GetResponseAVSResult();

Default Value

""

Remarks

Contains the Address Verification System result code. This one character property contains the Address Verification Service (AVS) result code. An AVS result code can provide additional information concerning the authentication of a particular transaction for which cardholder address verification was requested. An AVS result code of "0" will be returned in the response message when no address verification has been requested. The value returned should be stored for later retrieval, as it may be required when voiding or refunding a transaction. Valid AVS response codes are listed below, and are identical across all Gateway (note that some gateways do not return an AVS response).

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

Adyen

For Adyen, this property will contain the following possible values:

American Payment Solutions

For American Payment Solutions, this property will contain the following possible values:

Barclay

For Barclay, the property will contain the following possible values:

BlueSnap

For BlueSnap, the property will contain a 3-character string (if AVS checks were done), which contains the AVS checks for the following properties:

The possible values for each result character are:

HSBC

For HSBC, the property will contain the following possible values:

PayTrace / PayTraceJSON

For PayTrace / PayTraceJSON, the property will contain the following possible values:

QBMS

For the QBMS gateway, the ResponseAVSResult property will contain the result for the street address, a comma, and then the result for the zip code. The values returned are "Pass", "Fail", and "NotAvailable". Therefore, an ResponseAVSResult of "Fail,Pass" means that the street address failed validation, but the zip code passed.

DataCash

For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):

Stripe

For Stripe, the property will contain the following possible values:

Worldpay

For Worldpay, the property will contain a 4-character string, which contains the AVS checks for the following properties:

The possible values for each result character are:

Worldpay Online

For Worldpay Online, the property will contain one of the following:

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

Data Type

String

ResponseCode Property (Retail Class)

Indicates the status of the authorization request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCode();

Unicode (Windows)
LPWSTR GetResponseCode();

char* inpay_retail_getresponsecode(void* lpObj);

QString GetResponseCode();

Default Value

""

Remarks

Indicates the status of the authorization request. This property contains the actual response code as returned by the Gateway. Unlike the ResponseApproved property, this ResponseCode property may provide more details about why a transaction was declined. Therefore, it is recommended that developers check the ResponseCode as well as the ResponseApproved property. The Point of Sale system should evaluate this response code and NOT the ResponseText to determine nature of a response message. The current (at the time of this release) response codes for the supported Gateways are listed in the table of contents to your left.

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

Data Type

String

ResponseCVVResult Property (Retail Class)

Contains the returned CVV2 result code if it was requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseCVVResult();

Unicode (Windows)
LPWSTR GetResponseCVVResult();

char* inpay_retail_getresponsecvvresult(void* lpObj);

QString GetResponseCVVResult();

Default Value

""

Remarks

Contains the returned CVV2 result code if it was requested. This property contains the host returned CVV2 result code (if CVV data was sent in the request). The following is a list of current result codes:

A gateway may also support custom codes or human-readable response messages in this property. Please consult your gateway documentation to determine if CVV2 codes are supported.

Note: Some gateways use their own response codes instead of those in the above table; those response codes are detailed below for such gateways.

HSBC

For HSBC, the property will contain:

Adyen

For Adyen, the property will contain:

Barclay

For Barclay, the property will contain:

BlueSnap

For BlueSnap, the property will contain:

(Note: There are some scenarios in which the property will be empty instead, refer to BlueSnap's documentation for more details.)

DataCash

For DataCash, the property will contain the following possible values (of which correspond to both AVS and CVV checks):

Stripe

For Stripe, the property will contain the following possible values:

Worldpay Online

For Worldpay Online, the property will contain one of the following:

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

Data Type

String

ResponseData Property (Retail Class)

The entire response returned from the gateway processor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseData();

Unicode (Windows)
LPWSTR GetResponseData();

char* inpay_retail_getresponsedata(void* lpObj);

QString GetResponseData();

Default Value

""

Remarks

The entire response returned from the gateway processor. This property contains the entire response returned from the gateway processor. You may use this to parse additional information that is not returned in the standard response properties.

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

Data Type

String

ResponseErrorCode Property (Retail Class)

Additional error code returned by some gateways.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseErrorCode();

Unicode (Windows)
LPWSTR GetResponseErrorCode();

char* inpay_retail_getresponseerrorcode(void* lpObj);

QString GetResponseErrorCode();

Default Value

""

Remarks

Additional error code returned by some gateways. If a gateway returns it, this property will contain an additional code that may explain why the transaction was declined. You may also wish to inspect ResponseErrorText for a human-readable description of this ResponseErrorCode.

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

Data Type

String

ResponseErrorText Property (Retail Class)

Additional error description returned by some gateways.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseErrorText();

Unicode (Windows)
LPWSTR GetResponseErrorText();

char* inpay_retail_getresponseerrortext(void* lpObj);

QString GetResponseErrorText();

Default Value

""

Remarks

Additional error description returned by some gateways. If a gateway returns it, this property will contain a human-readable description of the error which occurred (if any). You may also wish to inspect ResponseErrorCode for an accompanying code which may be parsed and used by your application.

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

Data Type

String

ResponseInvoiceNumber Property (Retail Class)

Invoice number submitted in authorization request (if applicable).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseInvoiceNumber();

Unicode (Windows)
LPWSTR GetResponseInvoiceNumber();

char* inpay_retail_getresponseinvoicenumber(void* lpObj);

QString GetResponseInvoiceNumber();

Default Value

""

Remarks

Invoice number submitted in authorization request (if applicable). This property contains the Invoice Number submitted in the original transaction, echoed back by the Gateway host.

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

Data Type

String

ResponseProcessorCode Property (Retail Class)

Response code from the underlying processor.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseProcessorCode();

Unicode (Windows)
LPWSTR GetResponseProcessorCode();

char* inpay_retail_getresponseprocessorcode(void* lpObj);

QString GetResponseProcessorCode();

Default Value

""

Remarks

Response code from the underlying processor. Often times a Gateway will return a ResponseCode that indicates only whether the transaction is approved or declined. Many of these also include a secondary code that provides more details as to why the transaction was declined.

Note, for the PayFlowPro Gateway this property will contain a "1" if the transaction was a duplicate, a "-1" if duplicate checking service is unavailable, and will be blank for a successfully authorized transaction.

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

Data Type

String

ResponseText Property (Retail Class)

Text information that describes each response code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseText();

Unicode (Windows)
LPWSTR GetResponseText();

char* inpay_retail_getresponsetext(void* lpObj);

QString GetResponseText();

Default Value

""

Remarks

Text information that describes each response code. This property contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. A Gateway may translate the response according to the language indicated in the merchant account setup (if applicable).

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

Data Type

String

ResponseTransactionId Property (Retail Class)

Contains the Visa Transaction Identifier or MasterCard Reference Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResponseTransactionId();

Unicode (Windows)
LPWSTR GetResponseTransactionId();

char* inpay_retail_getresponsetransactionid(void* lpObj);

QString GetResponseTransactionId();

Default Value

""

Remarks

Contains the Visa Transaction Identifier or MasterCard Reference Number. This property contains a transaction identifier or reference number. The Point of Sale (POS) device should not attempt to interpret the meaning of any data appearing in this property. Data returned in this property (if any) should be recorded and used to submit a modification of this transaction at a later time (such as voiding the transaction or capturing an authorization-only transaction, if applicable).

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

Data Type

String

ShippingAddress Property (Retail Class)

Customer's shipping street address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingAddress();
int SetShippingAddress(const char* lpszShippingAddress);

Unicode (Windows)
LPWSTR GetShippingAddress();
INT SetShippingAddress(LPCWSTR lpszShippingAddress);

char* inpay_retail_getshippingaddress(void* lpObj);
int inpay_retail_setshippingaddress(void* lpObj, const char* lpszShippingAddress);

QString GetShippingAddress();
int SetShippingAddress(QString qsShippingAddress);

Default Value

""

Remarks

Customer's shipping street address.

This property is not available at design time.

Data Type

String

ShippingAddress2 Property (Retail Class)

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingAddress2();
int SetShippingAddress2(const char* lpszShippingAddress2);

Unicode (Windows)
LPWSTR GetShippingAddress2();
INT SetShippingAddress2(LPCWSTR lpszShippingAddress2);

char* inpay_retail_getshippingaddress2(void* lpObj);
int inpay_retail_setshippingaddress2(void* lpObj, const char* lpszShippingAddress2);

QString GetShippingAddress2();
int SetShippingAddress2(QString qsShippingAddress2);

Default Value

""

Remarks

A specific detail on the customer's shipping address (such as building, suite, apartment, floor number etc.).

This property is not available at design time.

Data Type

String

ShippingCity Property (Retail Class)

Customer's shipping city.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingCity();
int SetShippingCity(const char* lpszShippingCity);

Unicode (Windows)
LPWSTR GetShippingCity();
INT SetShippingCity(LPCWSTR lpszShippingCity);

char* inpay_retail_getshippingcity(void* lpObj);
int inpay_retail_setshippingcity(void* lpObj, const char* lpszShippingCity);

QString GetShippingCity();
int SetShippingCity(QString qsShippingCity);

Default Value

""

Remarks

Customer's shipping city.

This property is not available at design time.

Data Type

String

ShippingCountry Property (Retail Class)

Customer's shipping country.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingCountry();
int SetShippingCountry(const char* lpszShippingCountry);

Unicode (Windows)
LPWSTR GetShippingCountry();
INT SetShippingCountry(LPCWSTR lpszShippingCountry);

char* inpay_retail_getshippingcountry(void* lpObj);
int inpay_retail_setshippingcountry(void* lpObj, const char* lpszShippingCountry);

QString GetShippingCountry();
int SetShippingCountry(QString qsShippingCountry);

Default Value

""

Remarks

Customer's shipping country. This property contains the country in which the customer is located. Most gateways use a two-letter country code, specified in ISO-3166.

This property is not available at design time.

Data Type

String

ShippingEmail Property (Retail Class)

Customer's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingEmail();
int SetShippingEmail(const char* lpszShippingEmail);

Unicode (Windows)
LPWSTR GetShippingEmail();
INT SetShippingEmail(LPCWSTR lpszShippingEmail);

char* inpay_retail_getshippingemail(void* lpObj);
int inpay_retail_setshippingemail(void* lpObj, const char* lpszShippingEmail);

QString GetShippingEmail();
int SetShippingEmail(QString qsShippingEmail);

Default Value

""

Remarks

Customer's email address.

This property is not available at design time.

Data Type

String

ShippingFirstName Property (Retail Class)

Customer's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingFirstName();
int SetShippingFirstName(const char* lpszShippingFirstName);

Unicode (Windows)
LPWSTR GetShippingFirstName();
INT SetShippingFirstName(LPCWSTR lpszShippingFirstName);

char* inpay_retail_getshippingfirstname(void* lpObj);
int inpay_retail_setshippingfirstname(void* lpObj, const char* lpszShippingFirstName);

QString GetShippingFirstName();
int SetShippingFirstName(QString qsShippingFirstName);

Default Value

""

Remarks

Customer's first name.

This property is not available at design time.

Data Type

String

ShippingLastName Property (Retail Class)

Customer's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingLastName();
int SetShippingLastName(const char* lpszShippingLastName);

Unicode (Windows)
LPWSTR GetShippingLastName();
INT SetShippingLastName(LPCWSTR lpszShippingLastName);

char* inpay_retail_getshippinglastname(void* lpObj);
int inpay_retail_setshippinglastname(void* lpObj, const char* lpszShippingLastName);

QString GetShippingLastName();
int SetShippingLastName(QString qsShippingLastName);

Default Value

""

Remarks

Customer's last name.

This property is not available at design time.

Data Type

String

ShippingPhone Property (Retail Class)

Customer's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingPhone();
int SetShippingPhone(const char* lpszShippingPhone);

Unicode (Windows)
LPWSTR GetShippingPhone();
INT SetShippingPhone(LPCWSTR lpszShippingPhone);

char* inpay_retail_getshippingphone(void* lpObj);
int inpay_retail_setshippingphone(void* lpObj, const char* lpszShippingPhone);

QString GetShippingPhone();
int SetShippingPhone(QString qsShippingPhone);

Default Value

""

Remarks

Customer's phone number.

This property is not available at design time.

Data Type

String

ShippingState Property (Retail Class)

Customer's shipping state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingState();
int SetShippingState(const char* lpszShippingState);

Unicode (Windows)
LPWSTR GetShippingState();
INT SetShippingState(LPCWSTR lpszShippingState);

char* inpay_retail_getshippingstate(void* lpObj);
int inpay_retail_setshippingstate(void* lpObj, const char* lpszShippingState);

QString GetShippingState();
int SetShippingState(QString qsShippingState);

Default Value

""

Remarks

Customer's shipping state.

This property is not available at design time.

Data Type

String

ShippingZip Property (Retail Class)

Customer's shipping zip code (or postal code if outside of the USA).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShippingZip();
int SetShippingZip(const char* lpszShippingZip);

Unicode (Windows)
LPWSTR GetShippingZip();
INT SetShippingZip(LPCWSTR lpszShippingZip);

char* inpay_retail_getshippingzip(void* lpObj);
int inpay_retail_setshippingzip(void* lpObj, const char* lpszShippingZip);

QString GetShippingZip();
int SetShippingZip(QString qsShippingZip);

Default Value

""

Remarks

Customer's shipping zip code (or postal code if outside of the USA).

This property is not available at design time.

Data Type

String

SpecialFieldCount Property (Retail Class)

The number of records in the SpecialField arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSpecialFieldCount();
int SetSpecialFieldCount(int iSpecialFieldCount);

Unicode (Windows)
INT GetSpecialFieldCount();
INT SetSpecialFieldCount(INT iSpecialFieldCount);

int inpay_retail_getspecialfieldcount(void* lpObj);
int inpay_retail_setspecialfieldcount(void* lpObj, int iSpecialFieldCount);

int GetSpecialFieldCount();
int SetSpecialFieldCount(int iSpecialFieldCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• SpecialFieldName
• SpecialFieldValue

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

This property is not available at design time.

Data Type

Integer

SpecialFieldName Property (Retail Class)

Name of special configuration property to submit in this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSpecialFieldName(int iFieldIndex);
int SetSpecialFieldName(int iFieldIndex, const char* lpszSpecialFieldName);

Unicode (Windows)
LPWSTR GetSpecialFieldName(INT iFieldIndex);
INT SetSpecialFieldName(INT iFieldIndex, LPCWSTR lpszSpecialFieldName);

char* inpay_retail_getspecialfieldname(void* lpObj, int fieldindex);
int inpay_retail_setspecialfieldname(void* lpObj, int fieldindex, const char* lpszSpecialFieldName);

QString GetSpecialFieldName(int iFieldIndex);
int SetSpecialFieldName(int iFieldIndex, QString qsSpecialFieldName);

Default Value

""

Remarks

Name of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.

This property is not applicable for the LinkPoint, FirstData, YourPay, PayFuse, or Orbital gateways.

The FieldIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SpecialFieldCount property.

This property is not available at design time.

Data Type

String

SpecialFieldValue Property (Retail Class)

Value of special configuration property to submit in this transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSpecialFieldValue(int iFieldIndex);
int SetSpecialFieldValue(int iFieldIndex, const char* lpszSpecialFieldValue);

Unicode (Windows)
LPWSTR GetSpecialFieldValue(INT iFieldIndex);
INT SetSpecialFieldValue(INT iFieldIndex, LPCWSTR lpszSpecialFieldValue);

char* inpay_retail_getspecialfieldvalue(void* lpObj, int fieldindex);
int inpay_retail_setspecialfieldvalue(void* lpObj, int fieldindex, const char* lpszSpecialFieldValue);

QString GetSpecialFieldValue(int iFieldIndex);
int SetSpecialFieldValue(int iFieldIndex, QString qsSpecialFieldValue);

Default Value

""

Remarks

Value of special configuration field to submit in this transaction. The SpecialFieldName and SpecialFieldValue properties can be used to send special gateway configuration and transaction properties for each transaction. These properties can also be used to extend the functionality of this class by submitting additional information to the gateway.